libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudControl.Types.ProgressEvent

Description

 
Synopsis

Documentation

data ProgressEvent Source #

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: newProgressEvent smart constructor.

Constructors

ProgressEvent' 

Fields

  • retryAfter :: Maybe POSIX

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

  • typeName :: Maybe Text

    The name of the resource type used in the operation.

  • requestToken :: Maybe Text

    The unique token representing this resource operation request.

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

  • resourceModel :: Maybe (Sensitive Text)

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

  • operation :: Maybe Operation

    The resource operation type.

  • identifier :: Maybe Text

    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.

  • operationStatus :: Maybe 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.
  • eventTime :: Maybe POSIX

    When the resource operation request was initiated.

  • statusMessage :: Maybe Text

    Any message explaining the current status.

  • errorCode :: Maybe HandlerErrorCode

    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/.

Instances

Instances details
Eq ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Methods

(==) :: ProgressEvent -> ProgressEvent -> Bool #

(/=) :: ProgressEvent -> ProgressEvent -> Bool #

Show ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Methods

showsPrec :: Int -> ProgressEvent -> ShowS #

show :: ProgressEvent -> String #

showList :: [ProgressEvent] -> ShowS #

Generic ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Associated Types

type Rep ProgressEvent :: Type -> Type #

Methods

from :: ProgressEvent -> Rep ProgressEvent x #

to :: Rep ProgressEvent x -> ProgressEvent #

NFData ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Methods

rnf :: ProgressEvent -> () #

Hashable ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Methods

hashWithSalt :: Int -> ProgressEvent -> Int #

hash :: ProgressEvent -> Int #

FromJSON ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

Methods

parseJSON :: Value -> Parser ProgressEvent #

parseJSONList :: Value -> Parser [ProgressEvent] #

type Rep ProgressEvent Source # 
Instance details

Defined in Amazonka.CloudControl.Types.ProgressEvent

type Rep ProgressEvent = D1 ('MetaData "ProgressEvent" "Amazonka.CloudControl.Types.ProgressEvent" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "ProgressEvent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "retryAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation))))) :*: ((S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "operationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperationStatus))) :*: (S1 ('MetaSel ('Just "eventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HandlerErrorCode)))))))

newProgressEvent :: ProgressEvent Source #

Create a value of ProgressEvent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:retryAfter:ProgressEvent', progressEvent_retryAfter - When to next request the status of this resource operation request.

$sel:typeName:ProgressEvent', progressEvent_typeName - The name of the resource type used in the operation.

$sel:requestToken:ProgressEvent', progressEvent_requestToken - The unique token representing this resource operation request.

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

$sel:resourceModel:ProgressEvent', progressEvent_resourceModel - A JSON string containing the resource model, consisting of each resource property and its current value.

$sel:operation:ProgressEvent', progressEvent_operation - The resource operation type.

$sel:identifier:ProgressEvent', progressEvent_identifier - 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.

$sel:operationStatus:ProgressEvent', progressEvent_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.

$sel:eventTime:ProgressEvent', progressEvent_eventTime - When the resource operation request was initiated.

$sel:statusMessage:ProgressEvent', progressEvent_statusMessage - Any message explaining the current status.

$sel:errorCode:ProgressEvent', progressEvent_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/.

progressEvent_retryAfter :: Lens' ProgressEvent (Maybe UTCTime) Source #

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

progressEvent_typeName :: Lens' ProgressEvent (Maybe Text) Source #

The name of the resource type used in the operation.

progressEvent_requestToken :: Lens' ProgressEvent (Maybe Text) Source #

The unique token representing this resource operation request.

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

progressEvent_resourceModel :: Lens' ProgressEvent (Maybe Text) Source #

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

progressEvent_operation :: Lens' ProgressEvent (Maybe Operation) Source #

The resource operation type.

progressEvent_identifier :: Lens' ProgressEvent (Maybe Text) Source #

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.

progressEvent_operationStatus :: Lens' ProgressEvent (Maybe OperationStatus) Source #

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.

progressEvent_eventTime :: Lens' ProgressEvent (Maybe UTCTime) Source #

When the resource operation request was initiated.

progressEvent_statusMessage :: Lens' ProgressEvent (Maybe Text) Source #

Any message explaining the current status.

progressEvent_errorCode :: Lens' ProgressEvent (Maybe HandlerErrorCode) Source #

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/.