Amazon VPC Lattice

2025/09/29 - Amazon VPC Lattice - 4 updated api methods

Changes  Adds support for specifying the number of IPv4 addresses in each ENI for the resource gateway for VPC Lattice.

CreateResourceGateway (updated) Link ¶
Changes (both)
{'ipv4AddressesPerEni': 'integer'}

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

See also: AWS API Documentation

Request Syntax

client.create_resource_gateway(
    clientToken='string',
    name='string',
    vpcIdentifier='string',
    subnetIds=[
        'string',
    ],
    securityGroupIds=[
        'string',
    ],
    ipAddressType='IPV4'|'IPV6'|'DUALSTACK',
    ipv4AddressesPerEni=123,
    tags={
        'string': 'string'
    }
)
type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

The name of the resource gateway.

type vpcIdentifier:

string

param vpcIdentifier:

The ID of the VPC for the resource gateway.

type subnetIds:

list

param subnetIds:

The IDs of the VPC subnets in which to create the resource gateway.

  • (string) --

type securityGroupIds:

list

param securityGroupIds:

The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.

  • (string) --

type ipAddressType:

string

param ipAddressType:

A resource gateway can have IPv4, IPv6 or dualstack addresses. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource, as described here:

  • **IPv4**Assign IPv4 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have IPv4 address ranges, and the resource also has an IPv4 address.

  • **IPv6**Assign IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets are IPv6 only subnets, and the resource also has an IPv6 address.

  • **Dualstack**Assign both IPv4 and IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have both IPv4 and IPv6 address ranges, and the resource either has an IPv4 or IPv6 address.

The IP address type of the resource gateway is independent of the IP address type of the client or the VPC endpoint through which the resource is accessed.

type ipv4AddressesPerEni:

integer

param ipv4AddressesPerEni:

The number of IPv4 addresses in each ENI for the resource gateway.

type tags:

dict

param tags:

The tags for the resource gateway.

  • (string) --

    The key of the tag.

    Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.

    • (string) --

      The value of the tag.

      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'id': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'vpcIdentifier': 'string',
    'subnetIds': [
        'string',
    ],
    'securityGroupIds': [
        'string',
    ],
    'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK',
    'ipv4AddressesPerEni': 123
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the resource gateway.

    • id (string) --

      The ID of the resource gateway.

    • arn (string) --

      The Amazon Resource Name (ARN) of the resource gateway.

    • status (string) --

      The status of the resource gateway.

    • vpcIdentifier (string) --

      The ID of the VPC.

    • subnetIds (list) --

      The IDs of the resource gateway subnets.

      • (string) --

    • securityGroupIds (list) --

      The IDs of the security groups for the resource gateway.

      • (string) --

    • ipAddressType (string) --

      The type of IP address for the resource gateway.

    • ipv4AddressesPerEni (integer) --

      The number of IPv4 addresses in each ENI for the resource gateway.

GetResourceGateway (updated) Link ¶
Changes (response)
{'ipv4AddressesPerEni': 'integer'}

Retrieves information about the specified resource gateway.

See also: AWS API Documentation

Request Syntax

client.get_resource_gateway(
    resourceGatewayIdentifier='string'
)
type resourceGatewayIdentifier:

string

param resourceGatewayIdentifier:

[REQUIRED]

The ID of the resource gateway.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • name (string) --

      The name of the resource gateway.

    • id (string) --

      The ID of the resource gateway.

    • arn (string) --

      The Amazon Resource Name (ARN) of the resource gateway.

    • status (string) --

      The status for the resource gateway.

    • vpcId (string) --

      The ID of the VPC for the resource gateway.

    • subnetIds (list) --

      The IDs of the VPC subnets for resource gateway.

      • (string) --

    • securityGroupIds (list) --

      The security group IDs associated with the resource gateway.

      • (string) --

    • ipAddressType (string) --

      The type of IP address for the resource gateway.

    • ipv4AddressesPerEni (integer) --

      The number of IPv4 addresses in each ENI for the resource gateway.

    • createdAt (datetime) --

      The date and time that the resource gateway was created, in ISO-8601 format.

    • lastUpdatedAt (datetime) --

      The date and time that the resource gateway was last updated, in ISO-8601 format.

ListResourceGateways (updated) Link ¶
Changes (response)
{'items': {'ipv4AddressesPerEni': 'integer'}}

Lists the resource gateways that you own or that were shared with you.

See also: AWS API Documentation

Request Syntax

client.list_resource_gateways(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum page size.

type nextToken:

string

param nextToken:

If there are additional results, a pagination token for the next page of results.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • items (list) --

      Information about the resource gateways.

      • (dict) --

        Summary information about a resource gateway.

        • name (string) --

          The name of the resource gateway.

        • id (string) --

          The ID of the resource gateway.

        • arn (string) --

          The Amazon Resource Name (ARN) of the resource gateway.

        • status (string) --

          The name of the resource gateway.

        • vpcIdentifier (string) --

          The ID of the VPC for the resource gateway.

        • subnetIds (list) --

          The IDs of the VPC subnets for the resource gateway.

          • (string) --

        • securityGroupIds (list) --

          The IDs of the security groups applied to the resource gateway.

          • (string) --

        • ipAddressType (string) --

          The type of IP address used by the resource gateway.

        • ipv4AddressesPerEni (integer) --

          The number of IPv4 addresses in each ENI for the resource gateway.

        • createdAt (datetime) --

          The date and time that the VPC endpoint association was created, in ISO-8601 format.

        • lastUpdatedAt (datetime) --

          The most recent date and time that the resource gateway was updated, in ISO-8601 format.

    • nextToken (string) --

      If there are additional results, a pagination token for the next page of results.

ListServiceNetworkResourceAssociations (updated) Link ¶
Changes (request)
{'includeChildren': 'boolean'}

Lists the associations between a service network and a resource configuration.

See also: AWS API Documentation

Request Syntax

client.list_service_network_resource_associations(
    serviceNetworkIdentifier='string',
    resourceConfigurationIdentifier='string',
    maxResults=123,
    nextToken='string',
    includeChildren=True|False
)
type serviceNetworkIdentifier:

string

param serviceNetworkIdentifier:

The ID of the service network.

type resourceConfigurationIdentifier:

string

param resourceConfigurationIdentifier:

The ID of the resource configuration.

type maxResults:

integer

param maxResults:

The maximum page size.

type nextToken:

string

param nextToken:

If there are additional results, a pagination token for the next page of results.

type includeChildren:

boolean

param includeChildren:

Include service network resource associations of the child resource configuration with the grouped resource configuration.

The type is boolean and the default value is false.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'arn': 'string',
            'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'resourceConfigurationId': 'string',
            'resourceConfigurationArn': 'string',
            'resourceConfigurationName': 'string',
            'serviceNetworkId': 'string',
            'serviceNetworkArn': 'string',
            'serviceNetworkName': 'string',
            'dnsEntry': {
                'domainName': 'string',
                'hostedZoneId': 'string'
            },
            'privateDnsEntry': {
                'domainName': 'string',
                'hostedZoneId': 'string'
            },
            'isManagedAssociation': True|False,
            'failureCode': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the associations.

      • (dict) --

        Summary information about an association between a service network and a resource configuration.

        • id (string) --

          The ID of the association between the service network and resource configuration.

        • arn (string) --

          The Amazon Resource Name (ARN) of the association.

        • status (string) --

          The status of the service network’s association with the resource configuration. If the deletion fails, try to delete again.

        • createdBy (string) --

          The account that created the association.

        • createdAt (datetime) --

          The date and time that the association was created, in ISO-8601 format.

        • resourceConfigurationId (string) --

          The ID of the resource configuration associated with the service network.

        • resourceConfigurationArn (string) --

          The Amazon Resource Name (ARN) of the association.

        • resourceConfigurationName (string) --

          The name of the resource configuration associated with the service network.

        • serviceNetworkId (string) --

          The ID of the service network associated with the resource configuration.

        • serviceNetworkArn (string) --

          The Amazon Resource Name (ARN) of the service network associated with the resource configuration.

        • serviceNetworkName (string) --

          The name of the service network associated with the resource configuration.

        • dnsEntry (dict) --

          The DNS entry for the service.

          • domainName (string) --

            The domain name of the service.

          • hostedZoneId (string) --

            The ID of the hosted zone.

        • privateDnsEntry (dict) --

          The private DNS entry for the service.

          • domainName (string) --

            The domain name of the service.

          • hostedZoneId (string) --

            The ID of the hosted zone.

        • isManagedAssociation (boolean) --

          Specifies whether the association is managed by Amazon.

        • failureCode (string) --

          The failure code.

    • nextToken (string) --

      If there are additional results, a pagination token for the next page of results.