MigrationHubRefactorSpaces / Client / list_services

list_services#

MigrationHubRefactorSpaces.Client.list_services(**kwargs)#

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ApplicationIdentifier (string) –

    [REQUIRED]

    The ID of the application.

  • 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

{
    'NextToken': 'string',
    'ServiceSummaryList': [
        {
            'ApplicationId': 'string',
            'Arn': 'string',
            'CreatedByAccountId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'EndpointType': 'LAMBDA'|'URL',
            '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'
            },
            'LambdaEndpoint': {
                'Arn': 'string'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Name': 'string',
            'OwnerAccountId': 'string',
            'ServiceId': 'string',
            'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'Tags': {
                'string': 'string'
            },
            'UrlEndpoint': {
                'HealthUrl': 'string',
                'Url': 'string'
            },
            'VpcId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The token for the next page of results.

    • ServiceSummaryList (list) –

      The list of ServiceSummary objects.

      • (dict) –

        A summary for the service as a response to ListServices.

        • ApplicationId (string) –

          The unique identifier of the application.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the service.

        • CreatedByAccountId (string) –

          The Amazon Web Services account ID of the service creator.

        • CreatedTime (datetime) –

          A timestamp that indicates when the service is created.

        • Description (string) –

          A description of the service.

        • EndpointType (string) –

          The endpoint type of the service.

        • EnvironmentId (string) –

          The unique identifier of the environment.

        • Error (dict) –

          Any error associated with the service 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.

        • LambdaEndpoint (dict) –

          A summary of the configuration for the Lambda endpoint type.

          • Arn (string) –

            The Amazon Resource Name (ARN) of the Lambda endpoint.

        • LastUpdatedTime (datetime) –

          A timestamp that indicates when the service was last updated.

        • Name (string) –

          The name of the service.

        • OwnerAccountId (string) –

          The Amazon Web Services account ID of the service owner.

        • ServiceId (string) –

          The unique identifier of the service.

        • State (string) –

          The current state of the service.

        • Tags (dict) –

          The tags assigned to the service.

          • (string) –

            • (string) –

        • UrlEndpoint (dict) –

          The summary of the configuration for the URL endpoint type.

          • HealthUrl (string) –

            The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

          • Url (string) –

            The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.

        • VpcId (string) –

          The ID of the virtual private cloud (VPC).

Exceptions