VPCLattice / Client / get_resource_gateway

get_resource_gateway#

VPCLattice.Client.get_resource_gateway(**kwargs)#

Retrieves information about the specified resource gateway.

Request Syntax

response = client.get_resource_gateway(
    resourceGatewayIdentifier='string'
)

Parameters:

resourceGatewayIdentifier (string) –

[REQUIRED]

The ID of the resource gateway.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'securityGroupIds': [
        'string',
    ],
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'subnetIds': [
        'string',
    ],
    'vpcId': 'string'
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the resource gateway.
- createdAt (datetime) –
  
  The date and time that the resource gateway was created, in ISO-8601 format.
- id (string) –
  
  The ID of the resource gateway.
- ipAddressType (string) –
  
  The type of IP address for the resource gateway.
- lastUpdatedAt (datetime) –
  
  The date and time that the resource gateway was last updated, in ISO-8601 format.
- name (string) –
  
  The name of the resource gateway.
- securityGroupIds (list) –
  
  The security group IDs associated with the resource gateway.
  - (string) –
- status (string) –
  
  The status for the resource gateway.
- subnetIds (list) –
  
  The IDs of the VPC subnets for resource gateway.
  - (string) –
- vpcId (string) –
  
  The ID of the VPC for the resource gateway.

Exceptions

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