VPCLattice / Client / update_service

update_service

VPCLattice.Client.update_service(**kwargs)

Updates the specified service.

See also: AWS API Documentation

Request Syntax

response = client.update_service(
    serviceIdentifier='string',
    certificateArn='string',
    authType='NONE'|'AWS_IAM',
    idleTimeoutSeconds=123
)
Parameters:

  • serviceIdentifier (string) –

    [REQUIRED]

    The ID or ARN of the service.

  • certificateArn (string) – The Amazon Resource Name (ARN) of the certificate.

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

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

Return type:

dict

Returns:

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.

Exceptions

  • VPCLattice.Client.exceptions.ValidationException

  • VPCLattice.Client.exceptions.AccessDeniedException

  • VPCLattice.Client.exceptions.ConflictException

  • VPCLattice.Client.exceptions.ResourceNotFoundException

  • VPCLattice.Client.exceptions.ThrottlingException

  • VPCLattice.Client.exceptions.ServiceQuotaExceededException

  • VPCLattice.Client.exceptions.InternalServerException