VPCLattice / Client / list_service_network_service_associations

list_service_network_service_associations¶

VPCLattice.Client.list_service_network_service_associations(**kwargs)¶

Lists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Every association in Amazon VPC Lattice has a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource is shared with another account, the association includes the local account ID as the prefix in the ARN.

Request Syntax

response = client.list_service_network_service_associations(
    serviceNetworkIdentifier='string',
    serviceIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

serviceNetworkIdentifier (string) – The ID or ARN of the service network.
serviceIdentifier (string) – The ID or ARN of the service.
maxResults (integer) – The maximum number of results to return.
nextToken (string) – A pagination token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
            'arn': 'string',
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'serviceId': 'string',
            'serviceName': 'string',
            'serviceArn': 'string',
            'serviceNetworkId': 'string',
            'serviceNetworkName': 'string',
            'serviceNetworkArn': 'string',
            'dnsEntry': {
                'domainName': 'string',
                'hostedZoneId': 'string'
            },
            'customDomainName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  Information about the associations.
  - (dict) –
    
    Summary information about an association between a service network and a service.
    - id (string) –
      
      The ID of the association.
    - status (string) –
      
      The status of the service network’s association with the service. If the deletion fails, try to delete again.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the association.
    - createdBy (string) –
      
      The account that created the association.
    - createdAt (datetime) –
      
      The date and time that the association was created, in ISO-8601 format.
    - serviceId (string) –
      
      The ID of the service.
    - serviceName (string) –
      
      The name of the service.
    - serviceArn (string) –
      
      The Amazon Resource Name (ARN) of the service.
    - serviceNetworkId (string) –
      
      The ID of the service network.
    - serviceNetworkName (string) –
      
      The name of the service network.
    - serviceNetworkArn (string) –
      
      The Amazon Resource Name (ARN) of the service network.
    - dnsEntry (dict) –
      
      The DNS information.
      - 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.
- nextToken (string) –
  
  If there are additional results, a pagination token for the next page of results.

Exceptions

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