Amazon Elastic Compute Cloud

2020/01/10 - Amazon Elastic Compute Cloud - 10 updated api methods

Changes  Update ec2 client to latest version

CreateEgressOnlyInternetGateway (updated) Link ¶
Changes (response)
{'EgressOnlyInternetGateway': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

See also: AWS API Documentation

Request Syntax

client.create_egress_only_internet_gateway(
    ClientToken='string',
    DryRun=True|False,
    VpcId='string'
)
type ClientToken:

string

param ClientToken:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

type DryRun:

boolean

param DryRun:

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.

type VpcId:

string

param VpcId:

[REQUIRED]

The ID of the VPC for which to create the egress-only internet gateway.

rtype:

dict

returns:

Response Syntax

{
    'ClientToken': 'string',
    'EgressOnlyInternetGateway': {
        'Attachments': [
            {
                'State': 'attaching'|'attached'|'detaching'|'detached',
                'VpcId': 'string'
            },
        ],
        'EgressOnlyInternetGatewayId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ClientToken (string) --

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • EgressOnlyInternetGateway (dict) --

      Information about the egress-only internet gateway.

      • Attachments (list) --

        Information about the attachment of the egress-only internet gateway.

        • (dict) --

          Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

          • State (string) --

            The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

          • VpcId (string) --

            The ID of the VPC.

      • EgressOnlyInternetGatewayId (string) --

        The ID of the egress-only internet gateway.

      • Tags (list) --

        The tags assigned to the egress-only internet gateway.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

CreateLocalGatewayRouteTableVpcAssociation (updated) Link ¶
Changes (response)
{'LocalGatewayRouteTableVpcAssociation': {'Tags': [{'Key': 'string',
                                                    'Value': 'string'}]}}

Associates the specified VPC with the specified local gateway route table.

See also: AWS API Documentation

Request Syntax

client.create_local_gateway_route_table_vpc_association(
    LocalGatewayRouteTableId='string',
    VpcId='string',
    DryRun=True|False
)
type LocalGatewayRouteTableId:

string

param LocalGatewayRouteTableId:

[REQUIRED]

The ID of the local gateway route table.

type VpcId:

string

param VpcId:

[REQUIRED]

The ID of the VPC.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayRouteTableVpcAssociation': {
        'LocalGatewayRouteTableVpcAssociationId': 'string',
        'LocalGatewayRouteTableId': 'string',
        'LocalGatewayId': 'string',
        'VpcId': 'string',
        'State': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • LocalGatewayRouteTableVpcAssociation (dict) --

      Information about the association.

      • LocalGatewayRouteTableVpcAssociationId (string) --

        The ID of the association.

      • LocalGatewayRouteTableId (string) --

        The ID of the local gateway route table.

      • LocalGatewayId (string) --

        The ID of the local gateway.

      • VpcId (string) --

        The ID of the VPC.

      • State (string) --

        The state of the association.

      • Tags (list) --

        The tags assigned to the association.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

DeleteLocalGatewayRouteTableVpcAssociation (updated) Link ¶
Changes (response)
{'LocalGatewayRouteTableVpcAssociation': {'Tags': [{'Key': 'string',
                                                    'Value': 'string'}]}}

Deletes the specified association between a VPC and local gateway route table.

See also: AWS API Documentation

Request Syntax

client.delete_local_gateway_route_table_vpc_association(
    LocalGatewayRouteTableVpcAssociationId='string',
    DryRun=True|False
)
type LocalGatewayRouteTableVpcAssociationId:

string

param LocalGatewayRouteTableVpcAssociationId:

[REQUIRED]

The ID of the association.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayRouteTableVpcAssociation': {
        'LocalGatewayRouteTableVpcAssociationId': 'string',
        'LocalGatewayRouteTableId': 'string',
        'LocalGatewayId': 'string',
        'VpcId': 'string',
        'State': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • LocalGatewayRouteTableVpcAssociation (dict) --

      Information about the association.

      • LocalGatewayRouteTableVpcAssociationId (string) --

        The ID of the association.

      • LocalGatewayRouteTableId (string) --

        The ID of the local gateway route table.

      • LocalGatewayId (string) --

        The ID of the local gateway.

      • VpcId (string) --

        The ID of the VPC.

      • State (string) --

        The state of the association.

      • Tags (list) --

        The tags assigned to the association.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

DescribeEgressOnlyInternetGateways (updated) Link ¶
Changes (request, response)
Request
{'Filters': [{'Name': 'string', 'Values': ['string']}]}
Response
{'EgressOnlyInternetGateways': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Describes one or more of your egress-only internet gateways.

See also: AWS API Documentation

Request Syntax

client.describe_egress_only_internet_gateways(
    DryRun=True|False,
    EgressOnlyInternetGatewayIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
type DryRun:

boolean

param DryRun:

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.

type EgressOnlyInternetGatewayIds:

list

param EgressOnlyInternetGatewayIds:

One or more egress-only internet gateway IDs.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type Filters:

list

param Filters:

One or more filters.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'EgressOnlyInternetGateways': [
        {
            'Attachments': [
                {
                    'State': 'attaching'|'attached'|'detaching'|'detached',
                    'VpcId': 'string'
                },
            ],
            'EgressOnlyInternetGatewayId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • EgressOnlyInternetGateways (list) --

      Information about the egress-only internet gateways.

      • (dict) --

        Describes an egress-only internet gateway.

        • Attachments (list) --

          Information about the attachment of the egress-only internet gateway.

          • (dict) --

            Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

            • State (string) --

              The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

            • VpcId (string) --

              The ID of the VPC.

        • EgressOnlyInternetGatewayId (string) --

          The ID of the egress-only internet gateway.

        • Tags (list) --

          The tags assigned to the egress-only internet gateway.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations (updated) Link ¶
Changes (response)
{'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': {'Tags': [{'Key': 'string',
                                                                       'Value': 'string'}]}}

Describes the associations between virtual interface groups and local gateway route tables.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateway_route_table_virtual_interface_group_associations(
    LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds:

list

param LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds:

The IDs of the associations.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': [
        {
            'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string',
            'LocalGatewayVirtualInterfaceGroupId': 'string',
            'LocalGatewayId': 'string',
            'LocalGatewayRouteTableId': 'string',
            'State': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGatewayRouteTableVirtualInterfaceGroupAssociations (list) --

      Information about the associations.

      • (dict) --

        Describes an association between a local gateway route table and a virtual interface group.

        • LocalGatewayRouteTableVirtualInterfaceGroupAssociationId (string) --

          The ID of the association.

        • LocalGatewayVirtualInterfaceGroupId (string) --

          The ID of the virtual interface group.

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • LocalGatewayRouteTableId (string) --

          The ID of the local gateway route table.

        • State (string) --

          The state of the association.

        • Tags (list) --

          The tags assigned to the association.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGatewayRouteTableVpcAssociations (updated) Link ¶
Changes (response)
{'LocalGatewayRouteTableVpcAssociations': {'Tags': [{'Key': 'string',
                                                     'Value': 'string'}]}}

Describes the specified associations between VPCs and local gateway route tables.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateway_route_table_vpc_associations(
    LocalGatewayRouteTableVpcAssociationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayRouteTableVpcAssociationIds:

list

param LocalGatewayRouteTableVpcAssociationIds:

The IDs of the associations.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayRouteTableVpcAssociations': [
        {
            'LocalGatewayRouteTableVpcAssociationId': 'string',
            'LocalGatewayRouteTableId': 'string',
            'LocalGatewayId': 'string',
            'VpcId': 'string',
            'State': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGatewayRouteTableVpcAssociations (list) --

      Information about the associations.

      • (dict) --

        Describes an association between a local gateway route table and a VPC.

        • LocalGatewayRouteTableVpcAssociationId (string) --

          The ID of the association.

        • LocalGatewayRouteTableId (string) --

          The ID of the local gateway route table.

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • VpcId (string) --

          The ID of the VPC.

        • State (string) --

          The state of the association.

        • Tags (list) --

          The tags assigned to the association.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGatewayRouteTables (updated) Link ¶
Changes (response)
{'LocalGatewayRouteTables': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateway_route_tables(
    LocalGatewayRouteTableIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayRouteTableIds:

list

param LocalGatewayRouteTableIds:

The IDs of the local gateway route tables.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayRouteTables': [
        {
            'LocalGatewayRouteTableId': 'string',
            'LocalGatewayId': 'string',
            'OutpostArn': 'string',
            'State': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGatewayRouteTables (list) --

      Information about the local gateway route tables.

      • (dict) --

        Describes a local gateway route table.

        • LocalGatewayRouteTableId (string) --

          The ID of the local gateway route table.

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • OutpostArn (string) --

          The Amazon Resource Name (ARN) of the Outpost.

        • State (string) --

          The state of the local gateway route table.

        • Tags (list) --

          The tags assigned to the local gateway route table.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGatewayVirtualInterfaceGroups (updated) Link ¶
Changes (response)
{'LocalGatewayVirtualInterfaceGroups': {'Tags': [{'Key': 'string',
                                                  'Value': 'string'}]}}

Describes the specified local gateway virtual interface groups.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateway_virtual_interface_groups(
    LocalGatewayVirtualInterfaceGroupIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayVirtualInterfaceGroupIds:

list

param LocalGatewayVirtualInterfaceGroupIds:

The IDs of the virtual interface groups.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayVirtualInterfaceGroups': [
        {
            'LocalGatewayVirtualInterfaceGroupId': 'string',
            'LocalGatewayVirtualInterfaceIds': [
                'string',
            ],
            'LocalGatewayId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGatewayVirtualInterfaceGroups (list) --

      The virtual interface groups.

      • (dict) --

        Describes a local gateway virtual interface group.

        • LocalGatewayVirtualInterfaceGroupId (string) --

          The ID of the virtual interface group.

        • LocalGatewayVirtualInterfaceIds (list) --

          The IDs of the virtual interfaces.

          • (string) --

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • Tags (list) --

          The tags assigned to the virtual interface group.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGatewayVirtualInterfaces (updated) Link ¶
Changes (response)
{'LocalGatewayVirtualInterfaces': {'Tags': [{'Key': 'string',
                                             'Value': 'string'}]}}

Describes the specified local gateway virtual interfaces.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateway_virtual_interfaces(
    LocalGatewayVirtualInterfaceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayVirtualInterfaceIds:

list

param LocalGatewayVirtualInterfaceIds:

The IDs of the virtual interfaces.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGatewayVirtualInterfaces': [
        {
            'LocalGatewayVirtualInterfaceId': 'string',
            'LocalGatewayId': 'string',
            'Vlan': 123,
            'LocalAddress': 'string',
            'PeerAddress': 'string',
            'LocalBgpAsn': 123,
            'PeerBgpAsn': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGatewayVirtualInterfaces (list) --

      Information about the virtual interfaces.

      • (dict) --

        Describes a local gateway virtual interface.

        • LocalGatewayVirtualInterfaceId (string) --

          The ID of the virtual interface.

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • Vlan (integer) --

          The ID of the VLAN.

        • LocalAddress (string) --

          The local address.

        • PeerAddress (string) --

          The peer address.

        • LocalBgpAsn (integer) --

          The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

        • PeerBgpAsn (integer) --

          The peer BGP ASN.

        • Tags (list) --

          The tags assigned to the virtual interface.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.

DescribeLocalGateways (updated) Link ¶
Changes (response)
{'LocalGateways': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

See also: AWS API Documentation

Request Syntax

client.describe_local_gateways(
    LocalGatewayIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
type LocalGatewayIds:

list

param LocalGatewayIds:

The IDs of the local gateways.

  • (string) --

type Filters:

list

param Filters:

One or more filters.

  • (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. The filters supported by a describe operation are documented with the describe operation. For example:

    • DescribeAvailabilityZones

    • DescribeImages

    • DescribeInstances

    • DescribeKeyPairs

    • DescribeSecurityGroups

    • DescribeSnapshots

    • DescribeSubnets

    • DescribeTags

    • DescribeVolumes

    • DescribeVpcs

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{
    'LocalGateways': [
        {
            'LocalGatewayId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'State': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LocalGateways (list) --

      Information about the local gateways.

      • (dict) --

        Describes a local gateway.

        • LocalGatewayId (string) --

          The ID of the local gateway.

        • OutpostArn (string) --

          The Amazon Resource Name (ARN) of the Outpost.

        • OwnerId (string) --

          The ID of the AWS account ID that owns the local gateway.

        • State (string) --

          The state of the local gateway.

        • Tags (list) --

          The tags assigned to the local gateway.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • 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.