EC2 / Client / get_transit_gateway_route_table_associations

get_transit_gateway_route_table_associations

EC2.Client.get_transit_gateway_route_table_associations(**kwargs)

Gets information about the associations for the specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_route_table_associations(
    TransitGatewayRouteTableId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayRouteTableId (string) –

  [REQUIRED]

  The ID of the transit gateway route table.

• Filters (list) –

  One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • transit-gateway-attachment-id - The ID of the attachment.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'Associations': [
        {
            'TransitGatewayAttachmentId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
            'State': 'associating'|'associated'|'disassociating'|'disassociated'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Associations (list) –

    Information about the associations.

    • (dict) –

      Describes an association between a route table and a resource attachment.

      • TransitGatewayAttachmentId (string) –

        The ID of the attachment.

      • ResourceId (string) –

        The ID of the resource.

      • ResourceType (string) –

        The resource type. Note that the tgw-peering resource type has been deprecated.

      • State (string) –

        The state of the association.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.