Class: Aws::CloudControlApi::Types::ProgressEvent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:resource_model]

Instance Attribute Summary collapse

Instance Attribute Details

#error_code ⇒ String

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.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#event_time ⇒ Time

When the resource operation request was initiated.

Returns:

  • (Time) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#hooks_request_token ⇒ String

The unique token representing the Hooks operation for the request.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#identifier ⇒ String

The primary identifier for the resource.

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

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#operation ⇒ String

The resource operation type.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#operation_status ⇒ String

The current status of the resource operation request.

  • PENDING: The resource operation hasn't 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.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#request_token ⇒ String

The unique token representing this resource operation request.

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

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#resource_model ⇒ String

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

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#retry_after ⇒ Time

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

Returns:

  • (Time) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#status_message ⇒ String

Any message explaining the current status.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end

#type_name ⇒ String

The name of the resource type used in the operation.

Returns:

  • (String) 


883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'gems/aws-sdk-cloudcontrolapi/lib/aws-sdk-cloudcontrolapi/types.rb', line 883

class ProgressEvent < Struct.new(
  :type_name,
  :identifier,
  :request_token,
  :hooks_request_token,
  :operation,
  :operation_status,
  :event_time,
  :resource_model,
  :status_message,
  :error_code,
  :retry_after)
  SENSITIVE = [:resource_model]
  include Aws::Structure
end