get_environment

get_environment(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

See also: AWS API Documentation

Request Syntax

response = client.get_environment(
    EnvironmentIdentifier='string'
)

Parameters

EnvironmentIdentifier (string) --

[REQUIRED]

The ID of the environment.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'Description': 'string',
    'EnvironmentId': 'string',
    'Error': {
        'AccountId': 'string',
        'AdditionalDetails': {
            'string': 'string'
        },
        'Code': 'INVALID_RESOURCE_STATE'|'RESOURCE_LIMIT_EXCEEDED'|'RESOURCE_CREATION_FAILURE'|'RESOURCE_UPDATE_FAILURE'|'SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE'|'RESOURCE_DELETION_FAILURE'|'RESOURCE_RETRIEVAL_FAILURE'|'RESOURCE_IN_USE'|'RESOURCE_NOT_FOUND'|'STATE_TRANSITION_FAILURE'|'REQUEST_LIMIT_EXCEEDED'|'NOT_AUTHORIZED',
        'Message': 'string',
        'ResourceIdentifier': 'string',
        'ResourceType': 'ENVIRONMENT'|'APPLICATION'|'ROUTE'|'SERVICE'|'TRANSIT_GATEWAY'|'TRANSIT_GATEWAY_ATTACHMENT'|'API_GATEWAY'|'NLB'|'TARGET_GROUP'|'LOAD_BALANCER_LISTENER'|'VPC_LINK'|'LAMBDA'|'VPC'|'SUBNET'|'ROUTE_TABLE'|'SECURITY_GROUP'|'VPC_ENDPOINT_SERVICE_CONFIGURATION'|'RESOURCE_SHARE'|'IAM_ROLE'
    },
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Name': 'string',
    'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
    'OwnerAccountId': 'string',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
    'Tags': {
        'string': 'string'
    },
    'TransitGatewayId': 'string'
}

Response Structure

• (dict) --
  • Arn (string) --

    The Amazon Resource Name (ARN) of the environment.

  • CreatedTime (datetime) --

    A timestamp that indicates when the environment is created.

  • Description (string) --

    The 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 to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

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

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

Exceptions

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