VPCLattice / Client / get_service

get_service¶

VPCLattice.Client.get_service(**kwargs)¶

Retrieves information about the specified service.

Request Syntax

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

Parameters:

serviceIdentifier (string) –

[REQUIRED]

The ID or ARN of the service.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- id (string) –
  
  The ID of the service.
- name (string) –
  
  The name of the service.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the service.
- createdAt (datetime) –
  
  The date and time that the service was created, in ISO-8601 format.
- lastUpdatedAt (datetime) –
  
  The date and time that the service was last updated, in ISO-8601 format.
- dnsEntry (dict) –
  
  The DNS name of the service.
  - domainName (string) –
    
    The domain name of the service.
  - hostedZoneId (string) –
    
    The ID of the hosted zone.
- customDomainName (string) –
  
  The custom domain name of the service.
- certificateArn (string) –
  
  The Amazon Resource Name (ARN) of the certificate.
- status (string) –
  
  The status of the service.
- authType (string) –
  
  The type of IAM policy.
- failureCode (string) –
  
  The failure code.
- failureMessage (string) –
  
  The failure message.

Exceptions

VPCLattice.Client.exceptions.ValidationException
VPCLattice.Client.exceptions.AccessDeniedException
VPCLattice.Client.exceptions.ResourceNotFoundException
VPCLattice.Client.exceptions.ThrottlingException
VPCLattice.Client.exceptions.InternalServerException