Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  • NextToken (string) -- The token for the next page of results.
Return type



Response Syntax

    'EnvironmentSummaryList': [
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'EnvironmentId': 'string',
            'Error': {
                'AccountId': 'string',
                'AdditionalDetails': {
                    'string': 'string'
                'Message': 'string',
                'ResourceIdentifier': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Name': 'string',
            'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'Tags': {
                'string': 'string'
            'TransitGatewayId': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) --

    • EnvironmentSummaryList (list) --

      The list of EnvironmentSummary objects.

      • (dict) --

        The summary information for environments as a response to ListEnvironments .

        • Arn (string) --

          The Amazon Resource Name (ARN) of the environment.

        • CreatedTime (datetime) --

          A timestamp that indicates when the environment is created.

        • Description (string) --

          A description of the environment.

        • EnvironmentId (string) --

          The unique identifier of the environment.

        • Error (dict) --

          Any error associated with the environment resource.

          • AccountId (string) --

            The Amazon Web Services account ID of the resource owner.

          • AdditionalDetails (dict) --

            Additional details about the error.

            • (string) --
              • (string) --
          • Code (string) --

            The error code associated with the error.

          • Message (string) --

            The message associated with the error.

          • ResourceIdentifier (string) --

            The ID of the resource.

          • ResourceType (string) --

            The type of resource.

        • LastUpdatedTime (datetime) --

          A timestamp that indicates when the environment was last updated.

        • Name (string) --

          The name of the environment.

        • NetworkFabricType (string) --

          The network fabric type of the environment.

        • OwnerAccountId (string) --

          The Amazon Web Services account ID of the environment owner.

        • State (string) --

          The current state of the environment.

        • Tags (dict) --

          The tags assigned to the environment.

          • (string) --
            • (string) --
        • TransitGatewayId (string) --

          The ID of the transit gateway set up by the environment.

    • NextToken (string) --

      The token for the next page of results.


  • MigrationHubRefactorSpaces.Client.exceptions.ResourceNotFoundException
  • MigrationHubRefactorSpaces.Client.exceptions.InternalServerException
  • MigrationHubRefactorSpaces.Client.exceptions.ValidationException
  • MigrationHubRefactorSpaces.Client.exceptions.ThrottlingException
  • MigrationHubRefactorSpaces.Client.exceptions.AccessDeniedException