ProgressEvent - AWS Cloud Control API

ProgressEvent

Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the AWS Cloud Control API User Guide.

Contents

ErrorCode

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

Type: String

Valid Values: NotUpdatable | InvalidRequest | AccessDenied | InvalidCredentials | AlreadyExists | NotFound | ResourceConflict | Throttling | ServiceLimitExceeded | NotStabilized | GeneralServiceException | ServiceInternalError | ServiceTimeout | NetworkFailure | InternalFailure

Required: No

EventTime

When the resource operation request was initiated.

Type: Timestamp

Required: No

Identifier

The primary identifier for the resource.

Note

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

Type: String

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

Pattern: .+

Required: No

Operation

The resource operation type.

Type: String

Valid Values: CREATE | DELETE | UPDATE

Required: No

OperationStatus

The current status of the resource operation request.

  • PENDING: The resource operation has not yet started.

  • IN_PROGRESS: The resource operation is currently in progress.

  • SUCCESS: The resource operation has successfully completed.

  • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

  • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

  • CANCEL_COMPLETE: The resource operation has been canceled.

Type: String

Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | CANCEL_IN_PROGRESS | CANCEL_COMPLETE

Required: No

RequestToken

The unique token representing this resource operation request.

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

Type: String

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

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

Required: No

ResourceModel

A JSON string containing the resource model, consisting of each resource property and its current value.

Type: String

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

Required: No

RetryAfter

When to next request the status of this resource operation request.

Type: Timestamp

Required: No

StatusMessage

Any message explaining the current status.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

TypeName

The name of the resource type used in the operation.

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: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: