Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_service

get_service(**kwargs)

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

See also: AWS API Documentation

Request Syntax

response = client.get_service(
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    ServiceIdentifier='string'
)
Parameters
  • ApplicationIdentifier (string) --

    [REQUIRED]

    The ID of the application.

  • EnvironmentIdentifier (string) --

    [REQUIRED]

    The ID of the environment.

  • ServiceIdentifier (string) --

    [REQUIRED]

    The ID of the service.

Return type

dict

Returns

Response Syntax

{
    '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) --

    • ApplicationId (string) --

      The ID 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) --

      The timestamp of when the service is created.

    • Description (string) --

      The 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) --

      The configuration for the Lambda endpoint type.

      The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.

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

      • (string) --
        • (string) --
    • UrlEndpoint (dict) --

      The configuration for the URL endpoint type.

      The Url isthe URL of the endpoint type.

      The HealthUrl is the health check URL of the endpoint type.

      • HealthUrl (string) --

        The health check URL of the URL endpoint type.

      • Url (string) --

        The HTTP URL endpoint.

    • VpcId (string) --

      The ID of the virtual private cloud (VPC).

Exceptions

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