2026/06/29 - Amazon VPC Lattice - 3 updated api methods
Changes Amazon VPC Lattice now supports mutable idle timeout configuration on VPC Lattice Services
{'idleTimeoutSeconds': 'integer'}
Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
For more information, see Services in the Amazon VPC Lattice User Guide.
See also: AWS API Documentation
Request Syntax
client.create_service(
clientToken='string',
name='string',
tags={
'string': 'string'
},
customDomainName='string',
certificateArn='string',
authType='NONE'|'AWS_IAM',
idleTimeoutSeconds=123
)
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. 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.
dict
The tags for the service.
(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
The custom domain name of the service.
string
The Amazon Resource Name (ARN) of the certificate.
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.
integer
The amount of time, in seconds, that a connection can remain idle (no data sent) before VPC Lattice closes it. The valid range is 60 to 600 seconds. If you don't specify a value, the default is 60 seconds. This setting does not change the maximum connection duration of 10 minutes; connections are still closed when they reach that limit.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'name': 'string',
'customDomainName': 'string',
'certificateArn': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
'authType': 'NONE'|'AWS_IAM',
'idleTimeoutSeconds': 123,
'dnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
}
}
Response Structure
(dict) --
id (string) --
The ID of the service.
arn (string) --
The Amazon Resource Name (ARN) of the service.
name (string) --
The name of the service.
customDomainName (string) --
The custom domain name of the service.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
status (string) --
The status. If the status is CREATE_FAILED, you must delete and recreate the service.
authType (string) --
The type of IAM policy.
idleTimeoutSeconds (integer) --
The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it.
dnsEntry (dict) --
The public DNS name of the service.
domainName (string) --
The domain name of the service.
hostedZoneId (string) --
The ID of the hosted zone.
{'idleTimeoutSeconds': 'integer'}
Retrieves information about the specified service.
See also: AWS API Documentation
Request Syntax
client.get_service(
serviceIdentifier='string'
)
string
[REQUIRED]
The ID or ARN of the service.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'dnsEntry': {
'domainName': 'string',
'hostedZoneId': 'string'
},
'customDomainName': 'string',
'certificateArn': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
'authType': 'NONE'|'AWS_IAM',
'idleTimeoutSeconds': 123,
'failureCode': 'string',
'failureMessage': 'string'
}
Response Structure
(dict) --
id (string) --
The ID of the service.
name (string) --
The name of the service.
arn (string) --
The Amazon Resource Name (ARN) of the service.
createdAt (datetime) --
The date and time that the service was created, in ISO-8601 format.
lastUpdatedAt (datetime) --
The date and time that the service was last updated, in ISO-8601 format.
dnsEntry (dict) --
The DNS name of the service.
domainName (string) --
The domain name of the service.
hostedZoneId (string) --
The ID of the hosted zone.
customDomainName (string) --
The custom domain name of the service.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
status (string) --
The status of the service.
authType (string) --
The type of IAM policy.
idleTimeoutSeconds (integer) --
The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it.
failureCode (string) --
The failure code.
failureMessage (string) --
The failure message.
{'idleTimeoutSeconds': 'integer'}
Updates the specified service.
See also: AWS API Documentation
Request Syntax
client.update_service(
serviceIdentifier='string',
certificateArn='string',
authType='NONE'|'AWS_IAM',
idleTimeoutSeconds=123
)
string
[REQUIRED]
The ID or ARN of the service.
string
The Amazon Resource Name (ARN) of the certificate.
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.
integer
The amount of time, in seconds, that a connection can remain idle (no data sent) before VPC Lattice closes it. The valid range is 60 to 600 seconds. If you don't specify a value, the default is 60 seconds. This setting does not change the maximum connection duration of 10 minutes; connections are still closed when they reach that limit.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'name': 'string',
'customDomainName': 'string',
'certificateArn': 'string',
'authType': 'NONE'|'AWS_IAM',
'idleTimeoutSeconds': 123
}
Response Structure
(dict) --
id (string) --
The ID of the service.
arn (string) --
The Amazon Resource Name (ARN) of the service.
name (string) --
The name of the service.
customDomainName (string) --
The custom domain name of the service.
certificateArn (string) --
The Amazon Resource Name (ARN) of the certificate.
authType (string) --
The type of IAM policy.
idleTimeoutSeconds (integer) --
The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it.