MigrationHubRefactorSpaces / Client / list_applications
list_applications#
- MigrationHubRefactorSpaces.Client.list_applications(**kwargs)#
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
See also: AWS API Documentation
Request Syntax
response = client.list_applications( EnvironmentIdentifier='string', MaxResults=123, NextToken='string' )
- Parameters:
EnvironmentIdentifier (string) –
[REQUIRED]
The ID of the environment.
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:
dict
- Returns:
Response Syntax
{ 'ApplicationSummaryList': [ { 'ApiGatewayProxy': { 'ApiGatewayId': 'string', 'EndpointType': 'REGIONAL'|'PRIVATE', 'NlbArn': 'string', 'NlbName': 'string', 'ProxyUrl': 'string', 'StageName': 'string', 'VpcLinkId': 'string' }, 'ApplicationId': 'string', 'Arn': 'string', 'CreatedByAccountId': 'string', 'CreatedTime': datetime(2015, 1, 1), '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', 'OwnerAccountId': 'string', 'ProxyType': 'API_GATEWAY', 'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'Tags': { 'string': 'string' }, 'VpcId': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
ApplicationSummaryList (list) –
The list of
ApplicationSummary
objects.(dict) –
The list of
ApplicationSummary
objects.ApiGatewayProxy (dict) –
The endpoint URL of the Amazon API Gateway proxy.
ApiGatewayId (string) –
The resource ID of the API Gateway for the proxy.
EndpointType (string) –
The type of API Gateway endpoint created.
NlbArn (string) –
The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
NlbName (string) –
The name of the Network Load Balancer that is configured by the API Gateway proxy.
ProxyUrl (string) –
The endpoint URL of the API Gateway proxy.
StageName (string) –
The name of the API Gateway stage. The name defaults to
prod
.VpcLinkId (string) –
The
VpcLink
ID of the API Gateway proxy.
ApplicationId (string) –
The unique identifier of the application.
Arn (string) –
The Amazon Resource Name (ARN) of the application.
CreatedByAccountId (string) –
The Amazon Web Services account ID of the application creator.
CreatedTime (datetime) –
A timestamp that indicates when the application is created.
EnvironmentId (string) –
The unique identifier of the environment.
Error (dict) –
Any error associated with the application 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 application was last updated.
Name (string) –
The name of the application.
OwnerAccountId (string) –
The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
ProxyType (string) –
The proxy type of the proxy created within the application.
State (string) –
The current state of the application.
Tags (dict) –
The tags assigned to the application.
(string) –
(string) –
VpcId (string) –
The ID of the virtual private cloud (VPC).
NextToken (string) –
The token for the next page of results.
Exceptions
MigrationHubRefactorSpaces.Client.exceptions.ResourceNotFoundException
MigrationHubRefactorSpaces.Client.exceptions.InternalServerException
MigrationHubRefactorSpaces.Client.exceptions.ConflictException
MigrationHubRefactorSpaces.Client.exceptions.ServiceQuotaExceededException
MigrationHubRefactorSpaces.Client.exceptions.ValidationException
MigrationHubRefactorSpaces.Client.exceptions.ThrottlingException
MigrationHubRefactorSpaces.Client.exceptions.AccessDeniedException