VPCLattice / Client / get_service

get_service

VPCLattice.Client.get_service(**kwargs)

Retrieves information about the specified service.

See also: AWS API Documentation

Request Syntax

response = client.get_service(
    serviceIdentifier='string'
)

Parameters:

serviceIdentifier (string) –

[REQUIRED]

The ID or Amazon Resource Name (ARN) of the service.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'authType': 'NONE'|'AWS_IAM',
    'certificateArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'customDomainName': 'string',
    'dnsEntry': {
        'domainName': 'string',
        'hostedZoneId': 'string'
    },
    'failureCode': 'string',
    'failureMessage': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • arn (string) –

    The Amazon Resource Name (ARN) of the service.

  • authType (string) –

    The type of IAM policy.

  • certificateArn (string) –

    The Amazon Resource Name (ARN) of the certificate.

  • createdAt (datetime) –

    The date and time that the service was created, specified in ISO-8601 format.

  • customDomainName (string) –

    The custom domain name of the service.

  • dnsEntry (dict) –

    The DNS name of the service.

    • domainName (string) –

      The domain name of the service.

    • hostedZoneId (string) –

      The ID of the hosted zone.

  • failureCode (string) –

    The failure code.

  • failureMessage (string) –

    The failure message.

  • id (string) –

    The ID of the service.

  • lastUpdatedAt (datetime) –

    The date and time that the service was last updated, specified in ISO-8601 format.

  • name (string) –

    The name of the service.

  • status (string) –

    The status of the service.

Exceptions

• VPCLattice.Client.exceptions.ValidationException

• VPCLattice.Client.exceptions.AccessDeniedException

• VPCLattice.Client.exceptions.ThrottlingException

• VPCLattice.Client.exceptions.ResourceNotFoundException

• VPCLattice.Client.exceptions.InternalServerException