UpdateResource

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that AWS Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the AWS Cloud Control API User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-A-Za-z0-9+/=]+

Required: No

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the AWS Cloud Control API User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: Yes

A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see Composing the patch document in the AWS Cloud Control API User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 262144.

Pattern: [\s\S]*

Required: Yes

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your AWS user credentials.

For more information, see Specifying credentials in the AWS Cloud Control API User Guide.

Type: String

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

Pattern: arn:.+:iam::[0-9]{12}:role/.+

Required: No

The name of the resource type.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 196.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}

Required: Yes

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-]+

Required: No

Represents the current status of the resource update request.

Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.

Type: ProgressEvent object

The resource with the name requested already exists.

HTTP Status Code: 400

The specified client token has already been used in another resource request.

It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

HTTP Status Code: 400

Another resource operation is currently being performed on this resource.

HTTP Status Code: 400

The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.

HTTP Status Code: 400

The resource handler has failed without a returning a more specific error code. This can include timeouts.

HTTP Status Code: 500

The resource handler has returned that an unexpected error occurred within the resource handler.

HTTP Status Code: 500

The resource handler has returned that the credentials provided by the user are invalid.

HTTP Status Code: 400

The resource handler has returned that invalid input from the user has generated a generic exception.

HTTP Status Code: 400

The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.

HTTP Status Code: 500

The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

HTTP Status Code: 400

One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.

HTTP Status Code: 400

Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.

HTTP Status Code: 400

The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.

HTTP Status Code: 400

A resource with the specified identifier can't be found.

HTTP Status Code: 400

The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

HTTP Status Code: 500

The resource handler has returned that a non-transient resource limit was reached on the service side.

HTTP Status Code: 400

The request was denied due to request throttling.

HTTP Status Code: 400

The specified extension doesn't exist in the CloudFormation registry.

HTTP Status Code: 400

The specified resource doesn't support this resource operation.

HTTP Status Code: 400