VPCLattice / Client / get_service_network

get_service_network¶

VPCLattice.Client.get_service_network(**kwargs)¶

Retrieves information about the specified service network.

Request Syntax

response = client.get_service_network(
    serviceNetworkIdentifier='string'
)

Parameters:

serviceNetworkIdentifier (string) –

[REQUIRED]

The ID or ARN of the service network.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'arn': 'string',
    'authType': 'NONE'|'AWS_IAM',
    'sharingConfig': {
        'enabled': True|False
    },
    'numberOfAssociatedVPCs': 123,
    'numberOfAssociatedServices': 123
}

Response Structure

(dict) –
- id (string) –
  
  The ID of the service network.
- name (string) –
  
  The name of the service network.
- createdAt (datetime) –
  
  The date and time that the service network was created, in ISO-8601 format.
- lastUpdatedAt (datetime) –
  
  The date and time of the last update, in ISO-8601 format.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the service network.
- authType (string) –
  
  The type of IAM policy.
- sharingConfig (dict) –
  
  Specifies if the service network is enabled for sharing.
  - enabled (boolean) –
    
    Specifies if the service network is enabled for sharing.
- numberOfAssociatedVPCs (integer) –
  
  The number of VPCs associated with the service network.
- numberOfAssociatedServices (integer) –
  
  The number of services associated with the service network.

Exceptions

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