Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateService

Updates the specified service.

Request Syntax


PATCH /services/serviceIdentifier HTTP/1.1
Content-type: application/json

{
   "authType": "string",
   "certificateArn": "string",
   "idleTimeoutSeconds": number
}

URI Request Parameters

The request uses the following URI parameters.

serviceIdentifier

The ID or ARN of the service.

Length Constraints: Minimum length of 17. Maximum length of 2048.

Pattern: ((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}))

Required: Yes

Request Body

The request accepts the following data in JSON format.

authType

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.

Type: String

Valid Values: NONE | AWS_IAM

Required: No

certificateArn

The Amazon Resource Name (ARN) of the certificate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?

Required: No

idleTimeoutSeconds

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.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 600.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "authType": "string",
   "certificateArn": "string",
   "customDomainName": "string",
   "id": "string",
   "idleTimeoutSeconds": number,
   "name": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the service.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}

authType

The type of IAM policy.

Type: String

Valid Values: NONE | AWS_IAM

certificateArn

The Amazon Resource Name (ARN) of the certificate.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?

customDomainName

The custom domain name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

id

The ID of the service.

Type: String

Length Constraints: Fixed length of 21.

Pattern: svc-[0-9a-z]{17}

idleTimeoutSeconds

The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 600.

name

The name of the service.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: (?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

quotaCode: The ID of the service quota that was exceeded.
resourceId: The resource ID.
resourceType: The resource type.
serviceCode: The service code.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The number of seconds to wait before retrying.
serviceCode: The service code.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

fieldList: The fields that failed validation.
reason: The reason.

HTTP Status Code: 400