MigrationHubRefactorSpaces.Paginator.
ListEnvironments
¶paginator = client.get_paginator('list_environments')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from MigrationHubRefactorSpaces.Client.list_environments()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'EnvironmentSummaryList': [
{
'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
The list of EnvironmentSummary
objects.
The summary information for environments as a response to ListEnvironments
.
The Amazon Resource Name (ARN) of the environment.
A timestamp that indicates when the environment is created.
A description of the environment.
The unique identifier of the environment.
Any error associated with the environment resource.
The Amazon Web Services account ID of the resource owner.
Additional details about the error.
The error code associated with the error.
The message associated with the error.
The ID of the resource.
The type of resource.
A timestamp that indicates when the environment was last updated.
The name of the environment.
The network fabric type of the environment.
The Amazon Web Services account ID of the environment owner.
The current state of the environment.
The tags assigned to the environment.
The ID of the transit gateway set up by the environment.