2024/12/02 - Amazon VPC Lattice - 17 new6 updated api methods
Changes Lattice APIs that allow sharing and access of VPC resources across accounts.
Deletes the specified resource configuration.
See also: AWS API Documentation
Request Syntax
client.delete_resource_configuration(
resourceConfigurationIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the resource configuration.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves information about the specified association between a service network and a resource configuration.
See also: AWS API Documentation
Request Syntax
client.get_service_network_resource_association(
serviceNetworkResourceAssociationIdentifier='string'
)
string
[REQUIRED]
The ID of the association.
dict
Response Syntax
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
},
'failureCode': 'string',
'failureReason': 'string',
'id': 'string',
'isManagedAssociation': True|False,
'lastUpdatedAt': datetime(2015, 1, 1),
'privateDnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
},
'resourceConfigurationArn': 'string',
'resourceConfigurationId': 'string',
'resourceConfigurationName': 'string',
'serviceNetworkArn': 'string',
'serviceNetworkId': 'string',
'serviceNetworkName': 'string',
'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the association.
createdAt (datetime) --
The date and time that the association was created, in ISO-8601 format.
createdBy (string) --
The account that created the association.
dnsEntry (dict) --
The DNS entry for the service.
domainName (string) --
The domain name of the service.
hostedZoneId (string) --
The ID of the hosted zone.
failureCode (string) --
The failure code.
failureReason (string) --
The reason the association request failed.
id (string) --
The ID of the association.
isManagedAssociation (boolean) --
Indicates whether the association is managed by Amazon.
lastUpdatedAt (datetime) --
The most recent date and time that the association was updated, in ISO-8601 format.
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.
resourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the association.
resourceConfigurationId (string) --
The ID of the resource configuration that is associated with the service network.
resourceConfigurationName (string) --
The name of the resource configuration that is associated with the service network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network that is associated with the resource configuration.
serviceNetworkId (string) --
The ID of the service network that is associated with the resource configuration.
serviceNetworkName (string) --
The name of the service network that is associated with the resource configuration.
status (string) --
The status of the association.
Lists the resource configurations owned by or shared with this account.
See also: AWS API Documentation
Request Syntax
client.list_resource_configurations(
maxResults=123,
nextToken='string',
resourceConfigurationGroupIdentifier='string',
resourceGatewayIdentifier='string'
)
integer
The maximum page size.
string
A pagination token for the next page of results.
string
The ID of the group resource configuration.
string
The ID of the resource gateway for the resource configuration.
dict
Response Syntax
{
'items': [
{
'amazonManaged': True|False,
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'resourceConfigurationGroupId': 'string',
'resourceGatewayId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the resource configurations.
(dict) --
Summary information about a resource configuration.
amazonManaged (boolean) --
Indicates whether the resource configuration was created and is managed by Amazon.
arn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
createdAt (datetime) --
The date and time that the resource configuration was created, in ISO-8601 format.
id (string) --
The ID of the resource configuration.
lastUpdatedAt (datetime) --
The most recent date and time that the resource configuration was updated, in ISO-8601 format.
name (string) --
The name of the resource configuration.
resourceConfigurationGroupId (string) --
The ID of the group resource configuration.
resourceGatewayId (string) --
The ID of the resource gateway.
status (string) --
The status of the resource configuration.
type (string) --
The type of resource configuration.
SINGLE - A single resource.
GROUP - A group of resources.
CHILD - A single resource that is part of a group resource configuration.
ARN - An Amazon Web Services resource.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.
Creates a resource gateway.
See also: AWS API Documentation
Request Syntax
client.create_resource_gateway(
clientToken='string',
ipAddressType='IPV4'|'IPV6'|'DUALSTACK',
name='string',
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags={
'string': 'string'
},
vpcIdentifier='string'
)
string
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.
string
The type of IP address used by the resource gateway.
string
[REQUIRED]
The name of the resource gateway.
list
The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.
(string) --
list
[REQUIRED]
The IDs of the VPC subnets in which to create the resource gateway.
(string) --
dict
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: _ . : / = + - @
string
[REQUIRED]
The ID of the VPC for the resource gateway.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK',
'name': 'string',
'securityGroupIds': [
'string',
],
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'subnetIds': [
'string',
],
'vpcIdentifier': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
id (string) --
The ID of the resource gateway.
ipAddressType (string) --
The type of IP address for the resource gateway.
name (string) --
The name of the resource gateway.
securityGroupIds (list) --
The IDs of the security groups for the resource gateway.
(string) --
status (string) --
The status of the resource gateway.
subnetIds (list) --
The IDs of the resource gateway subnets.
(string) --
vpcIdentifier (string) --
The ID of the VPC.
Deletes the specified resource gateway.
See also: AWS API Documentation
Request Syntax
client.delete_resource_gateway(
resourceGatewayIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the resource gateway.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'name': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
id (string) --
The ID of the resource gateway.
name (string) --
The name of the resource gateway.
status (string) --
The status of the resource gateway.
Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.create_service_network_resource_association(
clientToken='string',
resourceConfigurationIdentifier='string',
serviceNetworkIdentifier='string',
tags={
'string': 'string'
}
)
string
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.
string
[REQUIRED]
The ID of the resource configuration to associate with the service network.
string
[REQUIRED]
The ID of the service network to associate with the resource configuration.
dict
The tags for the association.
(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: _ . : / = + - @
dict
Response Syntax
{
'arn': 'string',
'createdBy': 'string',
'id': 'string',
'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the association.
createdBy (string) --
The ID of the account that created the association.
id (string) --
The ID of the association.
status (string) --
The status of the association.
Disassociates the resource configuration from the resource VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_resource_endpoint_association(
resourceEndpointAssociationIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the association.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'resourceConfigurationArn': 'string',
'resourceConfigurationId': 'string',
'vpcEndpointId': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the association.
id (string) --
The ID of the association.
resourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration associated with the VPC endpoint of type resource.
resourceConfigurationId (string) --
The ID of the resource configuration.
vpcEndpointId (string) --
The ID of the resource VPC endpoint that is associated with the resource configuration.
Deletes the association between a service network and a resource configuration.
See also: AWS API Documentation
Request Syntax
client.delete_service_network_resource_association(
serviceNetworkResourceAssociationIdentifier='string'
)
string
[REQUIRED]
The ID of the association.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the association.
id (string) --
The ID of the association.
status (string) --
The status of the association.
Retrieves information about the specified resource configuration.
See also: AWS API Documentation
Request Syntax
client.get_resource_configuration(
resourceConfigurationIdentifier='string'
)
string
[REQUIRED]
The ID of the resource configuration.
dict
Response Syntax
{
'allowAssociationToShareableServiceNetwork': True|False,
'amazonManaged': True|False,
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'customDomainName': 'string',
'failureReason': 'string',
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'portRanges': [
'string',
],
'protocol': 'TCP',
'resourceConfigurationDefinition': {
'arnResource': {
'arn': 'string'
},
'dnsResource': {
'domainName': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
},
'ipResource': {
'ipAddress': 'string'
}
},
'resourceConfigurationGroupId': 'string',
'resourceGatewayId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN'
}
Response Structure
(dict) --
allowAssociationToShareableServiceNetwork (boolean) --
Specifies whether the resource configuration is associated with a sharable service network.
amazonManaged (boolean) --
Indicates whether the resource configuration was created and is managed by Amazon.
arn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
createdAt (datetime) --
The date and time that the resource configuration was created, in ISO-8601 format.
customDomainName (string) --
The custom domain name of the resource configuration.
failureReason (string) --
The reason the create-resource-configuration request failed.
id (string) --
The ID of the resource configuration.
lastUpdatedAt (datetime) --
The most recent date and time that the resource configuration was updated, in ISO-8601 format.
name (string) --
The name of the resource configuration.
portRanges (list) --
The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
(string) --
protocol (string) --
The TCP protocol accepted by the specified resource configuration.
resourceConfigurationDefinition (dict) --
The resource configuration.
arnResource (dict) --
The Amazon Resource Name (ARN) of the resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
dnsResource (dict) --
The DNS name of the resource.
domainName (string) --
The domain name of the resource.
ipAddressType (string) --
The type of IP address.
ipResource (dict) --
The IP resource.
ipAddress (string) --
The IP address of the IP resource.
resourceConfigurationGroupId (string) --
The ID of the group resource configuration.
resourceGatewayId (string) --
The ID of the resource gateway used to connect to the resource configuration in a given VPC. You can specify the resource gateway identifier only for resource configurations with type SINGLE, GROUP, or ARN.
status (string) --
The status of the resource configuration.
type (string) --
The type of resource configuration.
SINGLE - A single resource.
GROUP - A group of resources.
CHILD - A single resource that is part of a group resource configuration.
ARN - An Amazon Web Services resource.
Lists the associations for the specified VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.list_resource_endpoint_associations(
maxResults=123,
nextToken='string',
resourceConfigurationIdentifier='string',
resourceEndpointAssociationIdentifier='string',
vpcEndpointId='string',
vpcEndpointOwner='string'
)
integer
The maximum page size.
string
A pagination token for the next page of results.
string
[REQUIRED]
The ID for the resource configuration associated with the VPC endpoint.
string
The ID of the association.
string
The ID of the VPC endpoint in the association.
string
The owner of the VPC endpoint in the association.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'id': 'string',
'resourceConfigurationArn': 'string',
'resourceConfigurationId': 'string',
'resourceConfigurationName': 'string',
'vpcEndpointId': 'string',
'vpcEndpointOwner': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the VPC endpoint associations.
(dict) --
Summary information about a VPC endpoint association.
arn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint association.
createdAt (datetime) --
The date and time that the VPC endpoint association was created, in ISO-8601 format.
createdBy (string) --
The account that created the association.
id (string) --
The ID of the VPC endpoint association.
resourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
resourceConfigurationId (string) --
The ID of the resource configuration.
resourceConfigurationName (string) --
The name of the resource configuration.
vpcEndpointId (string) --
The ID of the VPC endpoint.
vpcEndpointOwner (string) --
The owner of the VPC endpoint.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.
Lists the associations between a service network and a resource configuration.
See also: AWS API Documentation
Request Syntax
client.list_service_network_resource_associations(
maxResults=123,
nextToken='string',
resourceConfigurationIdentifier='string',
serviceNetworkIdentifier='string'
)
integer
The maximum page size.
string
If there are additional results, a pagination token for the next page of results.
string
The ID of the resource configurationk.
string
The ID of the service network.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
},
'failureCode': 'string',
'id': 'string',
'isManagedAssociation': True|False,
'privateDnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
},
'resourceConfigurationArn': 'string',
'resourceConfigurationId': 'string',
'resourceConfigurationName': 'string',
'serviceNetworkArn': 'string',
'serviceNetworkId': 'string',
'serviceNetworkName': 'string',
'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'PARTIAL'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'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.
arn (string) --
The Amazon Resource Name (ARN) of the association.
createdAt (datetime) --
The date and time that the association was created, in ISO-8601 format.
createdBy (string) --
The account that created the association.
dnsEntry (dict) --
The DNS entry for the service.
domainName (string) --
The domain name of the service.
hostedZoneId (string) --
The ID of the hosted zone.
failureCode (string) --
The failure code.
id (string) --
The ID of the association between the service network and resource configuration.
isManagedAssociation (boolean) --
Specifies whether the association is managed by Amazon.
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.
resourceConfigurationArn (string) --
The Amazon Resource Name (ARN) of the association.
resourceConfigurationId (string) --
The ID of the resource configuration associated with the service network.
resourceConfigurationName (string) --
The name of the resource configuration associated with the service network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network associated with the resource configuration.
serviceNetworkId (string) --
The ID of the service network associated with the resource configuration.
serviceNetworkName (string) --
The name of the service network associated with the resource configuration.
status (string) --
The status of the service network associated with the resource configuration.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.
Updates the specified resource configuration.
See also: AWS API Documentation
Request Syntax
client.update_resource_configuration(
allowAssociationToShareableServiceNetwork=True|False,
portRanges=[
'string',
],
resourceConfigurationDefinition={
'arnResource': {
'arn': 'string'
},
'dnsResource': {
'domainName': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
},
'ipResource': {
'ipAddress': 'string'
}
},
resourceConfigurationIdentifier='string'
)
boolean
Indicates whether to add the resource configuration to service networks that are shared with other accounts.
list
The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
(string) --
dict
The resource configuration.
arnResource (dict) --
The Amazon Resource Name (ARN) of the resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
dnsResource (dict) --
The DNS name of the resource.
domainName (string) --
The domain name of the resource.
ipAddressType (string) --
The type of IP address.
ipResource (dict) --
The IP resource.
ipAddress (string) --
The IP address of the IP resource.
string
[REQUIRED]
The ID of the resource configuration.
dict
Response Syntax
{
'allowAssociationToShareableServiceNetwork': True|False,
'arn': 'string',
'id': 'string',
'name': 'string',
'portRanges': [
'string',
],
'protocol': 'TCP',
'resourceConfigurationDefinition': {
'arnResource': {
'arn': 'string'
},
'dnsResource': {
'domainName': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
},
'ipResource': {
'ipAddress': 'string'
}
},
'resourceConfigurationGroupId': 'string',
'resourceGatewayId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN'
}
Response Structure
(dict) --
allowAssociationToShareableServiceNetwork (boolean) --
Indicates whether to add the resource configuration to service networks that are shared with other accounts.
arn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
id (string) --
The ID of the resource configuration.
name (string) --
The name of the resource configuration.
portRanges (list) --
The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30
(string) --
protocol (string) --
The TCP protocol accepted by the specified resource configuration.
resourceConfigurationDefinition (dict) --
The resource configuration.
arnResource (dict) --
The Amazon Resource Name (ARN) of the resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
dnsResource (dict) --
The DNS name of the resource.
domainName (string) --
The domain name of the resource.
ipAddressType (string) --
The type of IP address.
ipResource (dict) --
The IP resource.
ipAddress (string) --
The IP address of the IP resource.
resourceConfigurationGroupId (string) --
The ID of the group resource configuration.
resourceGatewayId (string) --
The ID of the resource gateway associated with the resource configuration.
status (string) --
The status of the resource configuration.
type (string) --
The type of resource configuration.
SINGLE - A single resource.
GROUP - A group of resources.
CHILD - A single resource that is part of a group resource configuration.
ARN - An Amazon Web Services resource.
Retrieves information about the specified resource gateway.
See also: AWS API Documentation
Request Syntax
client.get_resource_gateway(
resourceGatewayIdentifier='string'
)
string
[REQUIRED]
The ID of the resource gateway.
dict
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.
Updates the specified resource gateway.
See also: AWS API Documentation
Request Syntax
client.update_resource_gateway(
resourceGatewayIdentifier='string',
securityGroupIds=[
'string',
]
)
string
[REQUIRED]
The ID or ARN of the resource gateway.
list
The IDs of the security groups associated with the resource gateway.
(string) --
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'ipAddressType': 'IPV4'|'IPV6',
'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.
id (string) --
The ID of the resource gateway.
ipAddressType (string) --
The type of IP address used by the resource gateway.
name (string) --
The name of the resource gateway.
securityGroupIds (list) --
The IDs of the security groups associated with the resource gateway.
(string) --
status (string) --
The status of the resource gateway.
subnetIds (list) --
The IDs of the VPC subnets for the resource gateway.
(string) --
vpcId (string) --
The ID of the VPC for the resource gateway.
Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.create_resource_configuration(
allowAssociationToShareableServiceNetwork=True|False,
clientToken='string',
name='string',
portRanges=[
'string',
],
protocol='TCP',
resourceConfigurationDefinition={
'arnResource': {
'arn': 'string'
},
'dnsResource': {
'domainName': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
},
'ipResource': {
'ipAddress': 'string'
}
},
resourceConfigurationGroupIdentifier='string',
resourceGatewayIdentifier='string',
tags={
'string': 'string'
},
type='GROUP'|'CHILD'|'SINGLE'|'ARN'
)
boolean
(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.
string
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.
string
[REQUIRED]
The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
list
(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).
(string) --
string
(SINGLE, GROUP) The protocol accepted by the resource configuration.
dict
(SINGLE, CHILD, ARN) The resource configuration.
arnResource (dict) --
The Amazon Resource Name (ARN) of the resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
dnsResource (dict) --
The DNS name of the resource.
domainName (string) --
The domain name of the resource.
ipAddressType (string) --
The type of IP address.
ipResource (dict) --
The IP resource.
ipAddress (string) --
The IP address of the IP resource.
string
(CHILD) The ID or ARN of the parent resource configuration (type is GROUP). This is used to associate a child resource configuration with a group resource configuration.
string
(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.
dict
The tags for the resource configuration.
(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: _ . : / = + - @
string
[REQUIRED]
The type of resource configuration.
SINGLE - A single resource.
GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.
CHILD - A single resource that is part of a group resource configuration.
ARN - An Amazon Web Services resource.
dict
Response Syntax
{
'allowAssociationToShareableServiceNetwork': True|False,
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'failureReason': 'string',
'id': 'string',
'name': 'string',
'portRanges': [
'string',
],
'protocol': 'TCP',
'resourceConfigurationDefinition': {
'arnResource': {
'arn': 'string'
},
'dnsResource': {
'domainName': 'string',
'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK'
},
'ipResource': {
'ipAddress': 'string'
}
},
'resourceConfigurationGroupId': 'string',
'resourceGatewayId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'type': 'GROUP'|'CHILD'|'SINGLE'|'ARN'
}
Response Structure
(dict) --
allowAssociationToShareableServiceNetwork (boolean) --
Specifies whether the resource configuration can be associated with a sharable service network.
arn (string) --
The Amazon Resource Name (ARN) of the resource configuration.
createdAt (datetime) --
The date and time that the resource configuration was created, in ISO-8601 format.
failureReason (string) --
The reason that the request failed.
id (string) --
The ID of the resource configuration.
name (string) --
The name of the resource configuration.
portRanges (list) --
The port range.
(string) --
protocol (string) --
The protocol.
resourceConfigurationDefinition (dict) --
The resource configuration.
arnResource (dict) --
The Amazon Resource Name (ARN) of the resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
dnsResource (dict) --
The DNS name of the resource.
domainName (string) --
The domain name of the resource.
ipAddressType (string) --
The type of IP address.
ipResource (dict) --
The IP resource.
ipAddress (string) --
The IP address of the IP resource.
resourceConfigurationGroupId (string) --
The ID of the parent resource configuration (type is GROUP).
resourceGatewayId (string) --
The ID of the resource gateway associated with the resource configuration.
status (string) --
The current status of the resource configuration.
type (string) --
The type of resource configuration.
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'
)
integer
The maximum page size.
string
If there are additional results, a pagination token for the next page of results.
dict
Response Syntax
{
'items': [
{
'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',
],
'vpcIdentifier': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the resource gateways.
(dict) --
Summary information about a resource gateway.
arn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
createdAt (datetime) --
The date and time that the VPC endpoint association was created, in ISO-8601 format.
id (string) --
The ID of the resource gateway.
ipAddressType (string) --
The type of IP address used by the resource gateway.
lastUpdatedAt (datetime) --
The most recent date and time that the resource gateway was updated, in ISO-8601 format.
name (string) --
The name of the resource gateway.
securityGroupIds (list) --
The IDs of the security groups applied to the resource gateway.
(string) --
status (string) --
The name of the resource gateway.
subnetIds (list) --
The IDs of the VPC subnets for the resource gateway.
(string) --
vpcIdentifier (string) --
The ID of the VPC for the resource gateway.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.
Lists the associations between a service network and a VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.list_service_network_vpc_endpoint_associations(
maxResults=123,
nextToken='string',
serviceNetworkIdentifier='string'
)
integer
The maximum page size.
string
If there are additional results, a pagination token for the next page of results.
string
[REQUIRED]
The ID of the service network associated with the VPC endpoint.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'id': 'string',
'serviceNetworkArn': 'string',
'state': 'string',
'vpcEndpointId': 'string',
'vpcEndpointOwnerId': 'string',
'vpcId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the association between the VPC endpoint and service network.
(dict) --
Describes the association between a service network and a VPC endpoint.
createdAt (datetime) --
The date and time that the association was created, in ISO-8601 format.
id (string) --
The ID of the association.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
state (string) --
The state of the association.
vpcEndpointId (string) --
The ID of the VPC endpoint associated with the service network.
vpcEndpointOwnerId (string) --
The owner of the VPC endpoint associated with the service network.
vpcId (string) --
The ID of the VPC for the association.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.
{'serviceNetworkLogType': 'SERVICE | RESOURCE'}
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.
See also: AWS API Documentation
Request Syntax
client.create_access_log_subscription(
clientToken='string',
destinationArn='string',
resourceIdentifier='string',
serviceNetworkLogType='SERVICE'|'RESOURCE',
tags={
'string': 'string'
}
)
string
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.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.
string
[REQUIRED]
The ID or ARN of the service network or service.
string
The type of log that monitors your Amazon VPC Lattice service networks.
dict
The tags for the access log subscription.
(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: _ . : / = + - @
dict
Response Syntax
{
'arn': 'string',
'destinationArn': 'string',
'id': 'string',
'resourceArn': 'string',
'resourceId': 'string',
'serviceNetworkLogType': 'SERVICE'|'RESOURCE'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the access log subscription.
destinationArn (string) --
The Amazon Resource Name (ARN) of the log destination.
id (string) --
The ID of the access log subscription.
resourceArn (string) --
The Amazon Resource Name (ARN) of the service network or service.
resourceId (string) --
The ID of the service network or service.
serviceNetworkLogType (string) --
The type of log that monitors your Amazon VPC Lattice service networks.
{'sharingConfig': {'enabled': 'boolean'}}
Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
For more information, see Service networks in the Amazon VPC Lattice User Guide.
See also: AWS API Documentation
Request Syntax
client.create_service_network(
authType='NONE'|'AWS_IAM',
clientToken='string',
name='string',
sharingConfig={
'enabled': True|False
},
tags={
'string': 'string'
}
)
string
The type of IAM policy.
NONE: The resource does not use an IAM policy. This is the default.
AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
string
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.
string
[REQUIRED]
The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
dict
Specify if the service network should be enabled for sharing.
enabled (boolean) --
Specifies if the service network is enabled for sharing.
dict
The tags for the service network.
(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: _ . : / = + - @
dict
Response Syntax
{
'arn': 'string',
'authType': 'NONE'|'AWS_IAM',
'id': 'string',
'name': 'string',
'sharingConfig': {
'enabled': True|False
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the service network.
authType (string) --
The type of IAM policy.
id (string) --
The ID of the service network.
name (string) --
The name of the service network.
sharingConfig (dict) --
Specifies if the service network is enabled for sharing.
enabled (boolean) --
Specifies if the service network is enabled for sharing.
{'serviceNetworkLogType': 'SERVICE | RESOURCE'}
Retrieves information about the specified access log subscription.
See also: AWS API Documentation
Request Syntax
client.get_access_log_subscription(
accessLogSubscriptionIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the access log subscription.
dict
Response Syntax
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'destinationArn': 'string',
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceArn': 'string',
'resourceId': 'string',
'serviceNetworkLogType': 'SERVICE'|'RESOURCE'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the access log subscription.
createdAt (datetime) --
The date and time that the access log subscription was created, in ISO-8601 format.
destinationArn (string) --
The Amazon Resource Name (ARN) of the access log destination.
id (string) --
The ID of the access log subscription.
lastUpdatedAt (datetime) --
The date and time that the access log subscription was last updated, in ISO-8601 format.
resourceArn (string) --
The Amazon Resource Name (ARN) of the service network or service.
resourceId (string) --
The ID of the service network or service.
serviceNetworkLogType (string) --
The log type for the service network.
{'sharingConfig': {'enabled': 'boolean'}}
Retrieves information about the specified service network.
See also: AWS API Documentation
Request Syntax
client.get_service_network(
serviceNetworkIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the service network.
dict
Response Syntax
{
'arn': 'string',
'authType': 'NONE'|'AWS_IAM',
'createdAt': datetime(2015, 1, 1),
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'numberOfAssociatedServices': 123,
'numberOfAssociatedVPCs': 123,
'sharingConfig': {
'enabled': True|False
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the service network.
authType (string) --
The type of IAM policy.
createdAt (datetime) --
The date and time that the service network was created, in ISO-8601 format.
id (string) --
The ID of the service network.
lastUpdatedAt (datetime) --
The date and time of the last update, in ISO-8601 format.
name (string) --
The name of the service network.
numberOfAssociatedServices (integer) --
The number of services associated with the service network.
numberOfAssociatedVPCs (integer) --
The number of VPCs associated with the service network.
sharingConfig (dict) --
Specifies if the service network is enabled for sharing.
enabled (boolean) --
Specifies if the service network is enabled for sharing.
{'items': {'serviceNetworkLogType': 'SERVICE | RESOURCE'}}
Lists the access log subscriptions for the specified service network or service.
See also: AWS API Documentation
Request Syntax
client.list_access_log_subscriptions(
maxResults=123,
nextToken='string',
resourceIdentifier='string'
)
integer
The maximum number of results to return.
string
A pagination token for the next page of results.
string
[REQUIRED]
The ID or ARN of the service network or service.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'destinationArn': 'string',
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceArn': 'string',
'resourceId': 'string',
'serviceNetworkLogType': 'SERVICE'|'RESOURCE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the access log subscriptions.
(dict) --
Summary information about an access log subscription.
arn (string) --
The Amazon Resource Name (ARN) of the access log subscription
createdAt (datetime) --
The date and time that the access log subscription was created, in ISO-8601 format.
destinationArn (string) --
The Amazon Resource Name (ARN) of the destination.
id (string) --
The ID of the access log subscription.
lastUpdatedAt (datetime) --
The date and time that the access log subscription was last updated, in ISO-8601 format.
resourceArn (string) --
The Amazon Resource Name (ARN) of the service or service network.
resourceId (string) --
The ID of the service or service network.
serviceNetworkLogType (string) --
Log type of the service network.
nextToken (string) --
A pagination token for the next page of results.
{'items': {'numberOfAssociatedResourceConfigurations': 'long'}}
Lists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.
See also: AWS API Documentation
Request Syntax
client.list_service_networks(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return.
string
A pagination token for the next page of results.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'numberOfAssociatedResourceConfigurations': 123,
'numberOfAssociatedServices': 123,
'numberOfAssociatedVPCs': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Information about the service networks.
(dict) --
Summary information about a service network.
arn (string) --
The Amazon Resource Name (ARN) of the service network.
createdAt (datetime) --
The date and time that the service network was created, in ISO-8601 format.
id (string) --
The ID of the service network.
lastUpdatedAt (datetime) --
The date and time that the service network was last updated, in ISO-8601 format.
name (string) --
The name of the service network.
numberOfAssociatedResourceConfigurations (integer) --
The number of resource configurations associated with a service network.
numberOfAssociatedServices (integer) --
The number of services associated with the service network.
numberOfAssociatedVPCs (integer) --
The number of VPCs associated with the service network.
nextToken (string) --
If there are additional results, a pagination token for the next page of results.