-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon Cloud Control API SDK. -- -- Derived from API version 2021-09-30 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in Amazonka.CloudControl.Lens and -- are suitable for use with a lens package such as lens or -- lens-family-core. -- -- See Amazonka.CloudControl and the AWS documentation to -- get started. @package amazonka-cloudcontrol @version 2.0 module Amazonka.CloudControl.Types.HandlerErrorCode newtype HandlerErrorCode HandlerErrorCode' :: Text -> HandlerErrorCode [fromHandlerErrorCode] :: HandlerErrorCode -> Text pattern HandlerErrorCode_AccessDenied :: HandlerErrorCode pattern HandlerErrorCode_AlreadyExists :: HandlerErrorCode pattern HandlerErrorCode_GeneralServiceException :: HandlerErrorCode pattern HandlerErrorCode_InternalFailure :: HandlerErrorCode pattern HandlerErrorCode_InvalidCredentials :: HandlerErrorCode pattern HandlerErrorCode_InvalidRequest :: HandlerErrorCode pattern HandlerErrorCode_NetworkFailure :: HandlerErrorCode pattern HandlerErrorCode_NotFound :: HandlerErrorCode pattern HandlerErrorCode_NotStabilized :: HandlerErrorCode pattern HandlerErrorCode_NotUpdatable :: HandlerErrorCode pattern HandlerErrorCode_ResourceConflict :: HandlerErrorCode pattern HandlerErrorCode_ServiceInternalError :: HandlerErrorCode pattern HandlerErrorCode_ServiceLimitExceeded :: HandlerErrorCode pattern HandlerErrorCode_ServiceTimeout :: HandlerErrorCode pattern HandlerErrorCode_Throttling :: HandlerErrorCode instance Amazonka.Data.XML.ToXML Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.XML.FromXML Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.Headers.ToHeader Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.Log.ToLog Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.Text.ToText Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Amazonka.Data.Text.FromText Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance GHC.Generics.Generic Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance GHC.Classes.Ord Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance GHC.Classes.Eq Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance GHC.Read.Read Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode instance GHC.Show.Show Amazonka.CloudControl.Types.HandlerErrorCode.HandlerErrorCode module Amazonka.CloudControl.Types.Operation newtype Operation Operation' :: Text -> Operation [fromOperation] :: Operation -> Text pattern Operation_CREATE :: Operation pattern Operation_DELETE :: Operation pattern Operation_UPDATE :: Operation instance Amazonka.Data.XML.ToXML Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.XML.FromXML Amazonka.CloudControl.Types.Operation.Operation instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudControl.Types.Operation.Operation instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.Types.Operation.Operation instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudControl.Types.Operation.Operation instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.Headers.ToHeader Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.Log.ToLog Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.Text.ToText Amazonka.CloudControl.Types.Operation.Operation instance Amazonka.Data.Text.FromText Amazonka.CloudControl.Types.Operation.Operation instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.Operation.Operation instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.Operation.Operation instance GHC.Generics.Generic Amazonka.CloudControl.Types.Operation.Operation instance GHC.Classes.Ord Amazonka.CloudControl.Types.Operation.Operation instance GHC.Classes.Eq Amazonka.CloudControl.Types.Operation.Operation instance GHC.Read.Read Amazonka.CloudControl.Types.Operation.Operation instance GHC.Show.Show Amazonka.CloudControl.Types.Operation.Operation module Amazonka.CloudControl.Types.OperationStatus newtype OperationStatus OperationStatus' :: Text -> OperationStatus [fromOperationStatus] :: OperationStatus -> Text pattern OperationStatus_CANCEL_COMPLETE :: OperationStatus pattern OperationStatus_CANCEL_IN_PROGRESS :: OperationStatus pattern OperationStatus_FAILED :: OperationStatus pattern OperationStatus_IN_PROGRESS :: OperationStatus pattern OperationStatus_PENDING :: OperationStatus pattern OperationStatus_SUCCESS :: OperationStatus instance Amazonka.Data.XML.ToXML Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.XML.FromXML Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.Headers.ToHeader Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.Log.ToLog Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.Text.ToText Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Amazonka.Data.Text.FromText Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance GHC.Generics.Generic Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance GHC.Classes.Ord Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance GHC.Classes.Eq Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance GHC.Read.Read Amazonka.CloudControl.Types.OperationStatus.OperationStatus instance GHC.Show.Show Amazonka.CloudControl.Types.OperationStatus.OperationStatus module Amazonka.CloudControl.Types.ProgressEvent -- | 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. data ProgressEvent ProgressEvent' :: Maybe HandlerErrorCode -> Maybe POSIX -> Maybe Text -> Maybe Operation -> Maybe OperationStatus -> Maybe Text -> Maybe (Sensitive Text) -> Maybe POSIX -> Maybe Text -> Maybe Text -> ProgressEvent -- | 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/. [$sel:errorCode:ProgressEvent'] :: ProgressEvent -> Maybe HandlerErrorCode -- | When the resource operation request was initiated. [$sel:eventTime:ProgressEvent'] :: ProgressEvent -> Maybe POSIX -- | 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:identifier:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | The resource operation type. [$sel:operation:ProgressEvent'] :: ProgressEvent -> Maybe Operation -- | The current status of the resource operation request. -- -- [$sel:operationStatus:ProgressEvent'] :: ProgressEvent -> Maybe OperationStatus -- | The unique token representing this resource operation request. -- -- Use the RequestToken with GetResourceRequestStatus to -- return the current status of a resource operation request. [$sel:requestToken:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | A JSON string containing the resource model, consisting of each -- resource property and its current value. [$sel:resourceModel:ProgressEvent'] :: ProgressEvent -> Maybe (Sensitive Text) -- | When to next request the status of this resource operation request. [$sel:retryAfter:ProgressEvent'] :: ProgressEvent -> Maybe POSIX -- | Any message explaining the current status. [$sel:statusMessage:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | The name of the resource type used in the operation. [$sel:typeName:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | 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: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/. -- -- $sel:eventTime:ProgressEvent', progressEvent_eventTime - -- When the resource operation request was initiated. -- -- $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:operation:ProgressEvent', progressEvent_operation - -- The resource operation type. -- -- $sel:operationStatus:ProgressEvent', -- progressEvent_operationStatus - The current status of the -- resource operation request. -- -- -- -- $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:retryAfter:ProgressEvent', progressEvent_retryAfter -- - When to next request the status of this resource operation request. -- -- $sel:statusMessage:ProgressEvent', -- progressEvent_statusMessage - Any message explaining the -- current status. -- -- $sel:typeName:ProgressEvent', progressEvent_typeName - -- The name of the resource type used in the operation. newProgressEvent :: ProgressEvent -- | 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_errorCode :: Lens' ProgressEvent (Maybe HandlerErrorCode) -- | When the resource operation request was initiated. progressEvent_eventTime :: Lens' ProgressEvent (Maybe UTCTime) -- | 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_identifier :: Lens' ProgressEvent (Maybe Text) -- | The resource operation type. progressEvent_operation :: Lens' ProgressEvent (Maybe Operation) -- | The current status of the resource operation request. -- -- progressEvent_operationStatus :: Lens' ProgressEvent (Maybe OperationStatus) -- | The unique token representing this resource operation request. -- -- Use the RequestToken with GetResourceRequestStatus to -- return the current status of a resource operation request. progressEvent_requestToken :: Lens' ProgressEvent (Maybe Text) -- | A JSON string containing the resource model, consisting of each -- resource property and its current value. progressEvent_resourceModel :: Lens' ProgressEvent (Maybe Text) -- | When to next request the status of this resource operation request. progressEvent_retryAfter :: Lens' ProgressEvent (Maybe UTCTime) -- | Any message explaining the current status. progressEvent_statusMessage :: Lens' ProgressEvent (Maybe Text) -- | The name of the resource type used in the operation. progressEvent_typeName :: Lens' ProgressEvent (Maybe Text) instance GHC.Generics.Generic Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent instance GHC.Show.Show Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent instance GHC.Classes.Eq Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.ProgressEvent.ProgressEvent module Amazonka.CloudControl.Types.ResourceDescription -- | Represents information about a provisioned resource. -- -- See: newResourceDescription smart constructor. data ResourceDescription ResourceDescription' :: Maybe Text -> Maybe (Sensitive Text) -> ResourceDescription -- | The primary identifier for the resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. [$sel:identifier:ResourceDescription'] :: ResourceDescription -> Maybe Text -- | A list of the resource properties and their current values. [$sel:properties:ResourceDescription'] :: ResourceDescription -> Maybe (Sensitive Text) -- | Create a value of ResourceDescription 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:identifier:ResourceDescription', -- resourceDescription_identifier - The primary identifier for the -- resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:properties:ResourceDescription', -- resourceDescription_properties - A list of the resource -- properties and their current values. newResourceDescription :: ResourceDescription -- | The primary identifier for the resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. resourceDescription_identifier :: Lens' ResourceDescription (Maybe Text) -- | A list of the resource properties and their current values. resourceDescription_properties :: Lens' ResourceDescription (Maybe Text) instance GHC.Generics.Generic Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription instance GHC.Show.Show Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription instance GHC.Classes.Eq Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.ResourceDescription.ResourceDescription module Amazonka.CloudControl.Types.ResourceRequestStatusFilter -- | The filter criteria to use in determining the requests returned. -- -- See: newResourceRequestStatusFilter smart constructor. data ResourceRequestStatusFilter ResourceRequestStatusFilter' :: Maybe [OperationStatus] -> Maybe [Operation] -> ResourceRequestStatusFilter -- | The operation statuses to include in the filter. -- -- [$sel:operationStatuses:ResourceRequestStatusFilter'] :: ResourceRequestStatusFilter -> Maybe [OperationStatus] -- | The operation types to include in the filter. [$sel:operations:ResourceRequestStatusFilter'] :: ResourceRequestStatusFilter -> Maybe [Operation] -- | Create a value of ResourceRequestStatusFilter 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:operationStatuses:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operationStatuses - The operation -- statuses to include in the filter. -- -- -- -- $sel:operations:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operations - The operation types to -- include in the filter. newResourceRequestStatusFilter :: ResourceRequestStatusFilter -- | The operation statuses to include in the filter. -- -- resourceRequestStatusFilter_operationStatuses :: Lens' ResourceRequestStatusFilter (Maybe [OperationStatus]) -- | The operation types to include in the filter. resourceRequestStatusFilter_operations :: Lens' ResourceRequestStatusFilter (Maybe [Operation]) instance GHC.Generics.Generic Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance GHC.Show.Show Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance GHC.Read.Read Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance GHC.Classes.Eq Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance Data.Hashable.Class.Hashable Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance Control.DeepSeq.NFData Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.Types.ResourceRequestStatusFilter.ResourceRequestStatusFilter module Amazonka.CloudControl.Types -- | API version 2021-09-30 of the Amazon Cloud Control API SDK -- configuration. defaultService :: Service -- | The resource with the name requested already exists. _AlreadyExistsException :: AsError a => Fold a ServiceError -- | 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. _ClientTokenConflictException :: AsError a => Fold a ServiceError -- | The resource is currently being modified by another operation. _ConcurrentModificationException :: AsError a => Fold a ServiceError -- | Another resource operation is currently being performed on this -- resource. _ConcurrentOperationException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream service -- generated an error that doesn't map to any other handler error code. _GeneralServiceException :: AsError a => Fold a ServiceError -- | The resource handler has failed without a returning a more specific -- error code. This can include timeouts. _HandlerFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that an unexpected error occurred -- within the resource handler. _HandlerInternalFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the credentials provided by the -- user are invalid. _InvalidCredentialsException :: AsError a => Fold a ServiceError -- | The resource handler has returned that invalid input from the user has -- generated a generic exception. _InvalidRequestException :: AsError a => Fold a ServiceError -- | 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. _NetworkFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream resource failed -- to complete all of its ready-state checks. _NotStabilizedException :: AsError a => Fold a ServiceError -- | One or more properties included in this resource operation are defined -- as create-only, and therefore can't be updated. _NotUpdatableException :: AsError a => Fold a ServiceError -- | 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. _PrivateTypeException :: AsError a => Fold a ServiceError -- | A resource operation with the specified request token can't be found. _RequestTokenNotFoundException :: AsError a => Fold a ServiceError -- | 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. _ResourceConflictException :: AsError a => Fold a ServiceError -- | A resource with the specified identifier can't be found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream service returned -- an internal error, typically with a 5XX HTTP status code. _ServiceInternalErrorException :: AsError a => Fold a ServiceError -- | The resource handler has returned that a non-transient resource limit -- was reached on the service side. _ServiceLimitExceededException :: AsError a => Fold a ServiceError -- | The request was denied due to request throttling. _ThrottlingException :: AsError a => Fold a ServiceError -- | The specified extension doesn't exist in the CloudFormation registry. _TypeNotFoundException :: AsError a => Fold a ServiceError -- | The specified resource doesn't support this resource operation. _UnsupportedActionException :: AsError a => Fold a ServiceError newtype HandlerErrorCode HandlerErrorCode' :: Text -> HandlerErrorCode [fromHandlerErrorCode] :: HandlerErrorCode -> Text pattern HandlerErrorCode_AccessDenied :: HandlerErrorCode pattern HandlerErrorCode_AlreadyExists :: HandlerErrorCode pattern HandlerErrorCode_GeneralServiceException :: HandlerErrorCode pattern HandlerErrorCode_InternalFailure :: HandlerErrorCode pattern HandlerErrorCode_InvalidCredentials :: HandlerErrorCode pattern HandlerErrorCode_InvalidRequest :: HandlerErrorCode pattern HandlerErrorCode_NetworkFailure :: HandlerErrorCode pattern HandlerErrorCode_NotFound :: HandlerErrorCode pattern HandlerErrorCode_NotStabilized :: HandlerErrorCode pattern HandlerErrorCode_NotUpdatable :: HandlerErrorCode pattern HandlerErrorCode_ResourceConflict :: HandlerErrorCode pattern HandlerErrorCode_ServiceInternalError :: HandlerErrorCode pattern HandlerErrorCode_ServiceLimitExceeded :: HandlerErrorCode pattern HandlerErrorCode_ServiceTimeout :: HandlerErrorCode pattern HandlerErrorCode_Throttling :: HandlerErrorCode newtype Operation Operation' :: Text -> Operation [fromOperation] :: Operation -> Text pattern Operation_CREATE :: Operation pattern Operation_DELETE :: Operation pattern Operation_UPDATE :: Operation newtype OperationStatus OperationStatus' :: Text -> OperationStatus [fromOperationStatus] :: OperationStatus -> Text pattern OperationStatus_CANCEL_COMPLETE :: OperationStatus pattern OperationStatus_CANCEL_IN_PROGRESS :: OperationStatus pattern OperationStatus_FAILED :: OperationStatus pattern OperationStatus_IN_PROGRESS :: OperationStatus pattern OperationStatus_PENDING :: OperationStatus pattern OperationStatus_SUCCESS :: OperationStatus -- | 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. data ProgressEvent ProgressEvent' :: Maybe HandlerErrorCode -> Maybe POSIX -> Maybe Text -> Maybe Operation -> Maybe OperationStatus -> Maybe Text -> Maybe (Sensitive Text) -> Maybe POSIX -> Maybe Text -> Maybe Text -> ProgressEvent -- | 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/. [$sel:errorCode:ProgressEvent'] :: ProgressEvent -> Maybe HandlerErrorCode -- | When the resource operation request was initiated. [$sel:eventTime:ProgressEvent'] :: ProgressEvent -> Maybe POSIX -- | 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:identifier:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | The resource operation type. [$sel:operation:ProgressEvent'] :: ProgressEvent -> Maybe Operation -- | The current status of the resource operation request. -- -- [$sel:operationStatus:ProgressEvent'] :: ProgressEvent -> Maybe OperationStatus -- | The unique token representing this resource operation request. -- -- Use the RequestToken with GetResourceRequestStatus to -- return the current status of a resource operation request. [$sel:requestToken:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | A JSON string containing the resource model, consisting of each -- resource property and its current value. [$sel:resourceModel:ProgressEvent'] :: ProgressEvent -> Maybe (Sensitive Text) -- | When to next request the status of this resource operation request. [$sel:retryAfter:ProgressEvent'] :: ProgressEvent -> Maybe POSIX -- | Any message explaining the current status. [$sel:statusMessage:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | The name of the resource type used in the operation. [$sel:typeName:ProgressEvent'] :: ProgressEvent -> Maybe Text -- | 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: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/. -- -- $sel:eventTime:ProgressEvent', progressEvent_eventTime - -- When the resource operation request was initiated. -- -- $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:operation:ProgressEvent', progressEvent_operation - -- The resource operation type. -- -- $sel:operationStatus:ProgressEvent', -- progressEvent_operationStatus - The current status of the -- resource operation request. -- -- -- -- $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:retryAfter:ProgressEvent', progressEvent_retryAfter -- - When to next request the status of this resource operation request. -- -- $sel:statusMessage:ProgressEvent', -- progressEvent_statusMessage - Any message explaining the -- current status. -- -- $sel:typeName:ProgressEvent', progressEvent_typeName - -- The name of the resource type used in the operation. newProgressEvent :: ProgressEvent -- | 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_errorCode :: Lens' ProgressEvent (Maybe HandlerErrorCode) -- | When the resource operation request was initiated. progressEvent_eventTime :: Lens' ProgressEvent (Maybe UTCTime) -- | 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_identifier :: Lens' ProgressEvent (Maybe Text) -- | The resource operation type. progressEvent_operation :: Lens' ProgressEvent (Maybe Operation) -- | The current status of the resource operation request. -- -- progressEvent_operationStatus :: Lens' ProgressEvent (Maybe OperationStatus) -- | The unique token representing this resource operation request. -- -- Use the RequestToken with GetResourceRequestStatus to -- return the current status of a resource operation request. progressEvent_requestToken :: Lens' ProgressEvent (Maybe Text) -- | A JSON string containing the resource model, consisting of each -- resource property and its current value. progressEvent_resourceModel :: Lens' ProgressEvent (Maybe Text) -- | When to next request the status of this resource operation request. progressEvent_retryAfter :: Lens' ProgressEvent (Maybe UTCTime) -- | Any message explaining the current status. progressEvent_statusMessage :: Lens' ProgressEvent (Maybe Text) -- | The name of the resource type used in the operation. progressEvent_typeName :: Lens' ProgressEvent (Maybe Text) -- | Represents information about a provisioned resource. -- -- See: newResourceDescription smart constructor. data ResourceDescription ResourceDescription' :: Maybe Text -> Maybe (Sensitive Text) -> ResourceDescription -- | The primary identifier for the resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. [$sel:identifier:ResourceDescription'] :: ResourceDescription -> Maybe Text -- | A list of the resource properties and their current values. [$sel:properties:ResourceDescription'] :: ResourceDescription -> Maybe (Sensitive Text) -- | Create a value of ResourceDescription 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:identifier:ResourceDescription', -- resourceDescription_identifier - The primary identifier for the -- resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:properties:ResourceDescription', -- resourceDescription_properties - A list of the resource -- properties and their current values. newResourceDescription :: ResourceDescription -- | The primary identifier for the resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. resourceDescription_identifier :: Lens' ResourceDescription (Maybe Text) -- | A list of the resource properties and their current values. resourceDescription_properties :: Lens' ResourceDescription (Maybe Text) -- | The filter criteria to use in determining the requests returned. -- -- See: newResourceRequestStatusFilter smart constructor. data ResourceRequestStatusFilter ResourceRequestStatusFilter' :: Maybe [OperationStatus] -> Maybe [Operation] -> ResourceRequestStatusFilter -- | The operation statuses to include in the filter. -- -- [$sel:operationStatuses:ResourceRequestStatusFilter'] :: ResourceRequestStatusFilter -> Maybe [OperationStatus] -- | The operation types to include in the filter. [$sel:operations:ResourceRequestStatusFilter'] :: ResourceRequestStatusFilter -> Maybe [Operation] -- | Create a value of ResourceRequestStatusFilter 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:operationStatuses:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operationStatuses - The operation -- statuses to include in the filter. -- -- -- -- $sel:operations:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operations - The operation types to -- include in the filter. newResourceRequestStatusFilter :: ResourceRequestStatusFilter -- | The operation statuses to include in the filter. -- -- resourceRequestStatusFilter_operationStatuses :: Lens' ResourceRequestStatusFilter (Maybe [OperationStatus]) -- | The operation types to include in the filter. resourceRequestStatusFilter_operations :: Lens' ResourceRequestStatusFilter (Maybe [Operation]) -- | Returns information about the specified resources. For more -- information, see Discovering resources in the Amazon Web -- Services Cloud Control API User Guide. -- -- You can use this action to return information about existing resources -- in your account and Amazon Web Services Region, whether those -- resources were provisioned using Cloud Control API. -- -- This operation returns paginated results. module Amazonka.CloudControl.ListResources -- | See: newListResources smart constructor. data ListResources ListResources' :: Maybe Natural -> Maybe Text -> Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Text -> ListResources -- | Reserved. [$sel:maxResults:ListResources'] :: ListResources -> Maybe Natural -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. [$sel:nextToken:ListResources'] :: ListResources -> Maybe Text -- | The resource model to use to select the resources to return. [$sel:resourceModel:ListResources'] :: ListResources -> Maybe (Sensitive Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. [$sel:roleArn:ListResources'] :: ListResources -> Maybe Text -- | 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. [$sel:typeVersionId:ListResources'] :: ListResources -> Maybe Text -- | The name of the resource type. [$sel:typeName:ListResources'] :: ListResources -> Text -- | Create a value of ListResources 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:maxResults:ListResources', listResources_maxResults -- - Reserved. -- -- ListResources, listResources_nextToken - If the previous -- paginated request didn't return all of the remaining results, the -- response object's NextToken parameter value is set to a -- token. To retrieve the next set of results, call this action again and -- assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. -- -- ListResources, listResources_resourceModel - The -- resource model to use to select the resources to return. -- -- $sel:roleArn:ListResources', listResources_roleArn - The -- Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:ListResources', -- listResources_typeVersionId - 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. -- -- ListResources, listResources_typeName - The name of the -- resource type. newListResources :: Text -> ListResources -- | Reserved. listResources_maxResults :: Lens' ListResources (Maybe Natural) -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. listResources_nextToken :: Lens' ListResources (Maybe Text) -- | The resource model to use to select the resources to return. listResources_resourceModel :: Lens' ListResources (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. listResources_roleArn :: Lens' ListResources (Maybe Text) -- | 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. listResources_typeVersionId :: Lens' ListResources (Maybe Text) -- | The name of the resource type. listResources_typeName :: Lens' ListResources Text -- | See: newListResourcesResponse smart constructor. data ListResourcesResponse ListResourcesResponse' :: Maybe Text -> Maybe [ResourceDescription] -> Maybe Text -> Int -> ListResourcesResponse -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. [$sel:nextToken:ListResourcesResponse'] :: ListResourcesResponse -> Maybe Text -- | Information about the specified resources, including primary -- identifier and resource model. [$sel:resourceDescriptions:ListResourcesResponse'] :: ListResourcesResponse -> Maybe [ResourceDescription] -- | The name of the resource type. [$sel:typeName:ListResourcesResponse'] :: ListResourcesResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListResourcesResponse'] :: ListResourcesResponse -> Int -- | Create a value of ListResourcesResponse 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: -- -- ListResources, listResourcesResponse_nextToken - If the -- request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. -- -- $sel:resourceDescriptions:ListResourcesResponse', -- listResourcesResponse_resourceDescriptions - Information about -- the specified resources, including primary identifier and resource -- model. -- -- ListResources, listResourcesResponse_typeName - The name -- of the resource type. -- -- $sel:httpStatus:ListResourcesResponse', -- listResourcesResponse_httpStatus - The response's http status -- code. newListResourcesResponse :: Int -> ListResourcesResponse -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text) -- | Information about the specified resources, including primary -- identifier and resource model. listResourcesResponse_resourceDescriptions :: Lens' ListResourcesResponse (Maybe [ResourceDescription]) -- | The name of the resource type. listResourcesResponse_typeName :: Lens' ListResourcesResponse (Maybe Text) -- | The response's http status code. listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.ListResources.ListResources instance GHC.Show.Show Amazonka.CloudControl.ListResources.ListResources instance GHC.Classes.Eq Amazonka.CloudControl.ListResources.ListResources instance GHC.Generics.Generic Amazonka.CloudControl.ListResources.ListResourcesResponse instance GHC.Show.Show Amazonka.CloudControl.ListResources.ListResourcesResponse instance GHC.Classes.Eq Amazonka.CloudControl.ListResources.ListResourcesResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.ListResources.ListResources instance Control.DeepSeq.NFData Amazonka.CloudControl.ListResources.ListResourcesResponse instance Amazonka.Pager.AWSPager Amazonka.CloudControl.ListResources.ListResources instance Data.Hashable.Class.Hashable Amazonka.CloudControl.ListResources.ListResources instance Control.DeepSeq.NFData Amazonka.CloudControl.ListResources.ListResources instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.ListResources.ListResources instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.ListResources.ListResources instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.ListResources.ListResources instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.ListResources.ListResources -- | Returns existing resource operation requests. This includes requests -- of all status types. For more information, see Listing active -- resource operation requests in the Amazon Web Services Cloud -- Control API User Guide. -- -- Resource operation requests expire after 7 days. -- -- This operation returns paginated results. module Amazonka.CloudControl.ListResourceRequests -- | See: newListResourceRequests smart constructor. data ListResourceRequests ListResourceRequests' :: Maybe Natural -> Maybe Text -> Maybe ResourceRequestStatusFilter -> ListResourceRequests -- | The maximum number of results to be returned with a single call. If -- the number of available results exceeds this maximum, the response -- includes a NextToken value that you can assign to the -- NextToken request parameter to get the next set of results. -- -- The default is 20. [$sel:maxResults:ListResourceRequests'] :: ListResourceRequests -> Maybe Natural -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. [$sel:nextToken:ListResourceRequests'] :: ListResourceRequests -> Maybe Text -- | The filter criteria to apply to the requests returned. [$sel:resourceRequestStatusFilter:ListResourceRequests'] :: ListResourceRequests -> Maybe ResourceRequestStatusFilter -- | Create a value of ListResourceRequests 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:maxResults:ListResourceRequests', -- listResourceRequests_maxResults - The maximum number of results -- to be returned with a single call. If the number of available results -- exceeds this maximum, the response includes a NextToken value -- that you can assign to the NextToken request parameter to get -- the next set of results. -- -- The default is 20. -- -- ListResourceRequests, listResourceRequests_nextToken - -- If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. -- -- $sel:resourceRequestStatusFilter:ListResourceRequests', -- listResourceRequests_resourceRequestStatusFilter - The filter -- criteria to apply to the requests returned. newListResourceRequests :: ListResourceRequests -- | The maximum number of results to be returned with a single call. If -- the number of available results exceeds this maximum, the response -- includes a NextToken value that you can assign to the -- NextToken request parameter to get the next set of results. -- -- The default is 20. listResourceRequests_maxResults :: Lens' ListResourceRequests (Maybe Natural) -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. listResourceRequests_nextToken :: Lens' ListResourceRequests (Maybe Text) -- | The filter criteria to apply to the requests returned. listResourceRequests_resourceRequestStatusFilter :: Lens' ListResourceRequests (Maybe ResourceRequestStatusFilter) -- | See: newListResourceRequestsResponse smart constructor. data ListResourceRequestsResponse ListResourceRequestsResponse' :: Maybe Text -> Maybe [ProgressEvent] -> Int -> ListResourceRequestsResponse -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. [$sel:nextToken:ListResourceRequestsResponse'] :: ListResourceRequestsResponse -> Maybe Text -- | The requests that match the specified filter criteria. [$sel:resourceRequestStatusSummaries:ListResourceRequestsResponse'] :: ListResourceRequestsResponse -> Maybe [ProgressEvent] -- | The response's http status code. [$sel:httpStatus:ListResourceRequestsResponse'] :: ListResourceRequestsResponse -> Int -- | Create a value of ListResourceRequestsResponse 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: -- -- ListResourceRequests, -- listResourceRequestsResponse_nextToken - If the request doesn't -- return all of the remaining results, NextToken is set to a -- token. To retrieve the next set of results, call -- ListResources again and assign that token to the request -- object's NextToken parameter. If the request returns all -- results, NextToken is set to null. -- -- -- $sel:resourceRequestStatusSummaries:ListResourceRequestsResponse', -- listResourceRequestsResponse_resourceRequestStatusSummaries - -- The requests that match the specified filter criteria. -- -- $sel:httpStatus:ListResourceRequestsResponse', -- listResourceRequestsResponse_httpStatus - The response's http -- status code. newListResourceRequestsResponse :: Int -> ListResourceRequestsResponse -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. listResourceRequestsResponse_nextToken :: Lens' ListResourceRequestsResponse (Maybe Text) -- | The requests that match the specified filter criteria. listResourceRequestsResponse_resourceRequestStatusSummaries :: Lens' ListResourceRequestsResponse (Maybe [ProgressEvent]) -- | The response's http status code. listResourceRequestsResponse_httpStatus :: Lens' ListResourceRequestsResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance GHC.Show.Show Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance GHC.Read.Read Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance GHC.Classes.Eq Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance GHC.Generics.Generic Amazonka.CloudControl.ListResourceRequests.ListResourceRequestsResponse instance GHC.Show.Show Amazonka.CloudControl.ListResourceRequests.ListResourceRequestsResponse instance GHC.Classes.Eq Amazonka.CloudControl.ListResourceRequests.ListResourceRequestsResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Control.DeepSeq.NFData Amazonka.CloudControl.ListResourceRequests.ListResourceRequestsResponse instance Amazonka.Pager.AWSPager Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Data.Hashable.Class.Hashable Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Control.DeepSeq.NFData Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.ListResourceRequests.ListResourceRequests instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.ListResourceRequests.ListResourceRequests -- | Returns the current status of a resource operation request. For more -- information, see Tracking the progress of resource operation -- requests in the Amazon Web Services Cloud Control API User -- Guide. module Amazonka.CloudControl.GetResourceRequestStatus -- | See: newGetResourceRequestStatus smart constructor. data GetResourceRequestStatus GetResourceRequestStatus' :: Text -> GetResourceRequestStatus -- | A unique token used to track the progress of the resource operation -- request. -- -- Request tokens are included in the ProgressEvent type -- returned by a resource operation request. [$sel:requestToken:GetResourceRequestStatus'] :: GetResourceRequestStatus -> Text -- | Create a value of GetResourceRequestStatus 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: -- -- GetResourceRequestStatus, -- getResourceRequestStatus_requestToken - A unique token used to -- track the progress of the resource operation request. -- -- Request tokens are included in the ProgressEvent type -- returned by a resource operation request. newGetResourceRequestStatus :: Text -> GetResourceRequestStatus -- | A unique token used to track the progress of the resource operation -- request. -- -- Request tokens are included in the ProgressEvent type -- returned by a resource operation request. getResourceRequestStatus_requestToken :: Lens' GetResourceRequestStatus Text -- | See: newGetResourceRequestStatusResponse smart -- constructor. data GetResourceRequestStatusResponse GetResourceRequestStatusResponse' :: Maybe ProgressEvent -> Int -> GetResourceRequestStatusResponse -- | Represents the current status of the resource operation request. [$sel:progressEvent:GetResourceRequestStatusResponse'] :: GetResourceRequestStatusResponse -> Maybe ProgressEvent -- | The response's http status code. [$sel:httpStatus:GetResourceRequestStatusResponse'] :: GetResourceRequestStatusResponse -> Int -- | Create a value of GetResourceRequestStatusResponse 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:progressEvent:GetResourceRequestStatusResponse', -- getResourceRequestStatusResponse_progressEvent - Represents the -- current status of the resource operation request. -- -- $sel:httpStatus:GetResourceRequestStatusResponse', -- getResourceRequestStatusResponse_httpStatus - The response's -- http status code. newGetResourceRequestStatusResponse :: Int -> GetResourceRequestStatusResponse -- | Represents the current status of the resource operation request. getResourceRequestStatusResponse_progressEvent :: Lens' GetResourceRequestStatusResponse (Maybe ProgressEvent) -- | The response's http status code. getResourceRequestStatusResponse_httpStatus :: Lens' GetResourceRequestStatusResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance GHC.Show.Show Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance GHC.Read.Read Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance GHC.Classes.Eq Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance GHC.Generics.Generic Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatusResponse instance GHC.Show.Show Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatusResponse instance GHC.Classes.Eq Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatusResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Control.DeepSeq.NFData Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatusResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Control.DeepSeq.NFData Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.GetResourceRequestStatus.GetResourceRequestStatus -- | Returns information about the current state of the specified resource. -- For details, see Reading a resource's current state. -- -- You can use this action to return information about an existing -- resource in your account and Amazon Web Services Region, whether those -- resources were provisioned using Cloud Control API. module Amazonka.CloudControl.GetResource -- | See: newGetResource smart constructor. data GetResource GetResource' :: Maybe Text -> Maybe Text -> Text -> Text -> GetResource -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. [$sel:roleArn:GetResource'] :: GetResource -> Maybe Text -- | 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. [$sel:typeVersionId:GetResource'] :: GetResource -> Maybe Text -- | The name of the resource type. [$sel:typeName:GetResource'] :: GetResource -> Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. [$sel:identifier:GetResource'] :: GetResource -> Text -- | Create a value of GetResource 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:roleArn:GetResource', getResource_roleArn - The -- Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:GetResource', -- getResource_typeVersionId - 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. -- -- GetResource, getResource_typeName - The name of the -- resource type. -- -- GetResource, getResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. newGetResource :: Text -> Text -> GetResource -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. getResource_roleArn :: Lens' GetResource (Maybe Text) -- | 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. getResource_typeVersionId :: Lens' GetResource (Maybe Text) -- | The name of the resource type. getResource_typeName :: Lens' GetResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. getResource_identifier :: Lens' GetResource Text -- | See: newGetResourceResponse smart constructor. data GetResourceResponse GetResourceResponse' :: Maybe ResourceDescription -> Maybe Text -> Int -> GetResourceResponse [$sel:resourceDescription:GetResourceResponse'] :: GetResourceResponse -> Maybe ResourceDescription -- | The name of the resource type. [$sel:typeName:GetResourceResponse'] :: GetResourceResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:GetResourceResponse'] :: GetResourceResponse -> Int -- | Create a value of GetResourceResponse 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:resourceDescription:GetResourceResponse', -- getResourceResponse_resourceDescription - Undocumented member. -- -- GetResource, getResourceResponse_typeName - The name of -- the resource type. -- -- $sel:httpStatus:GetResourceResponse', -- getResourceResponse_httpStatus - The response's http status -- code. newGetResourceResponse :: Int -> GetResourceResponse -- | Undocumented member. getResourceResponse_resourceDescription :: Lens' GetResourceResponse (Maybe ResourceDescription) -- | The name of the resource type. getResourceResponse_typeName :: Lens' GetResourceResponse (Maybe Text) -- | The response's http status code. getResourceResponse_httpStatus :: Lens' GetResourceResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.GetResource.GetResource instance GHC.Show.Show Amazonka.CloudControl.GetResource.GetResource instance GHC.Read.Read Amazonka.CloudControl.GetResource.GetResource instance GHC.Classes.Eq Amazonka.CloudControl.GetResource.GetResource instance GHC.Generics.Generic Amazonka.CloudControl.GetResource.GetResourceResponse instance GHC.Show.Show Amazonka.CloudControl.GetResource.GetResourceResponse instance GHC.Classes.Eq Amazonka.CloudControl.GetResource.GetResourceResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.GetResource.GetResource instance Control.DeepSeq.NFData Amazonka.CloudControl.GetResource.GetResourceResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.GetResource.GetResource instance Control.DeepSeq.NFData Amazonka.CloudControl.GetResource.GetResource instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.GetResource.GetResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.GetResource.GetResource instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.GetResource.GetResource instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.GetResource.GetResource -- | Deletes the specified resource. For details, see Deleting a -- resource in the Amazon Web Services Cloud Control API User -- Guide. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. module Amazonka.CloudControl.DeleteResource -- | See: newDeleteResource smart constructor. data DeleteResource DeleteResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> DeleteResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. [$sel:clientToken:DeleteResource'] :: DeleteResource -> Maybe Text -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. [$sel:roleArn:DeleteResource'] :: DeleteResource -> Maybe Text -- | 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. [$sel:typeVersionId:DeleteResource'] :: DeleteResource -> Maybe Text -- | The name of the resource type. [$sel:typeName:DeleteResource'] :: DeleteResource -> Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. [$sel:identifier:DeleteResource'] :: DeleteResource -> Text -- | Create a value of DeleteResource 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:clientToken:DeleteResource', -- deleteResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:DeleteResource', deleteResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:DeleteResource', -- deleteResource_typeVersionId - 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. -- -- DeleteResource, deleteResource_typeName - The name of -- the resource type. -- -- DeleteResource, deleteResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. newDeleteResource :: Text -> Text -> DeleteResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. deleteResource_clientToken :: Lens' DeleteResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. deleteResource_roleArn :: Lens' DeleteResource (Maybe Text) -- | 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. deleteResource_typeVersionId :: Lens' DeleteResource (Maybe Text) -- | The name of the resource type. deleteResource_typeName :: Lens' DeleteResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. deleteResource_identifier :: Lens' DeleteResource Text -- | See: newDeleteResourceResponse smart constructor. data DeleteResourceResponse DeleteResourceResponse' :: Maybe ProgressEvent -> Int -> DeleteResourceResponse -- | Represents the current status of the resource deletion request. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. [$sel:progressEvent:DeleteResourceResponse'] :: DeleteResourceResponse -> Maybe ProgressEvent -- | The response's http status code. [$sel:httpStatus:DeleteResourceResponse'] :: DeleteResourceResponse -> Int -- | Create a value of DeleteResourceResponse 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:progressEvent:DeleteResourceResponse', -- deleteResourceResponse_progressEvent - Represents the current -- status of the resource deletion request. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. -- -- $sel:httpStatus:DeleteResourceResponse', -- deleteResourceResponse_httpStatus - The response's http status -- code. newDeleteResourceResponse :: Int -> DeleteResourceResponse -- | Represents the current status of the resource deletion request. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. deleteResourceResponse_progressEvent :: Lens' DeleteResourceResponse (Maybe ProgressEvent) -- | The response's http status code. deleteResourceResponse_httpStatus :: Lens' DeleteResourceResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.DeleteResource.DeleteResource instance GHC.Show.Show Amazonka.CloudControl.DeleteResource.DeleteResource instance GHC.Read.Read Amazonka.CloudControl.DeleteResource.DeleteResource instance GHC.Classes.Eq Amazonka.CloudControl.DeleteResource.DeleteResource instance GHC.Generics.Generic Amazonka.CloudControl.DeleteResource.DeleteResourceResponse instance GHC.Show.Show Amazonka.CloudControl.DeleteResource.DeleteResourceResponse instance GHC.Classes.Eq Amazonka.CloudControl.DeleteResource.DeleteResourceResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.DeleteResource.DeleteResource instance Control.DeepSeq.NFData Amazonka.CloudControl.DeleteResource.DeleteResourceResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.DeleteResource.DeleteResource instance Control.DeepSeq.NFData Amazonka.CloudControl.DeleteResource.DeleteResource instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.DeleteResource.DeleteResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.DeleteResource.DeleteResource instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.DeleteResource.DeleteResource instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.DeleteResource.DeleteResource -- | Creates the specified resource. For more information, see Creating -- a resource in the Amazon Web Services Cloud Control API User -- Guide. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent type returned by CreateResource. module Amazonka.CloudControl.CreateResource -- | See: newCreateResource smart constructor. data CreateResource CreateResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Sensitive Text -> CreateResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. [$sel:clientToken:CreateResource'] :: CreateResource -> Maybe Text -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. [$sel:roleArn:CreateResource'] :: CreateResource -> Maybe Text -- | 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. [$sel:typeVersionId:CreateResource'] :: CreateResource -> Maybe Text -- | The name of the resource type. [$sel:typeName:CreateResource'] :: CreateResource -> Text -- | Structured data format representing the desired state of the resource, -- consisting of that resource's properties and their desired values. -- -- Cloud Control API currently supports JSON as a structured data format. -- -- 
--   <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
--
[$sel:desiredState:CreateResource'] :: CreateResource -> Sensitive Text -- | Create a value of CreateResource 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:clientToken:CreateResource', -- createResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:CreateResource', createResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:CreateResource', -- createResource_typeVersionId - 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. -- -- CreateResource, createResource_typeName - The name of -- the resource type. -- -- $sel:desiredState:CreateResource', -- createResource_desiredState - Structured data format -- representing the desired state of the resource, consisting of that -- resource's properties and their desired values. -- -- Cloud Control API currently supports JSON as a structured data format. -- -- 
--   <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
--
newCreateResource :: Text -> Text -> CreateResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. createResource_clientToken :: Lens' CreateResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. createResource_roleArn :: Lens' CreateResource (Maybe Text) -- | 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. createResource_typeVersionId :: Lens' CreateResource (Maybe Text) -- | The name of the resource type. createResource_typeName :: Lens' CreateResource Text -- | Structured data format representing the desired state of the resource, -- consisting of that resource's properties and their desired values. -- -- Cloud Control API currently supports JSON as a structured data format. -- -- 
--   <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
--
createResource_desiredState :: Lens' CreateResource Text -- | See: newCreateResourceResponse smart constructor. data CreateResourceResponse CreateResourceResponse' :: Maybe ProgressEvent -> Int -> CreateResourceResponse -- | Represents the current status of the resource creation request. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by CreateResource. [$sel:progressEvent:CreateResourceResponse'] :: CreateResourceResponse -> Maybe ProgressEvent -- | The response's http status code. [$sel:httpStatus:CreateResourceResponse'] :: CreateResourceResponse -> Int -- | Create a value of CreateResourceResponse 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:progressEvent:CreateResourceResponse', -- createResourceResponse_progressEvent - Represents the current -- status of the resource creation request. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by CreateResource. -- -- $sel:httpStatus:CreateResourceResponse', -- createResourceResponse_httpStatus - The response's http status -- code. newCreateResourceResponse :: Int -> CreateResourceResponse -- | Represents the current status of the resource creation request. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by CreateResource. createResourceResponse_progressEvent :: Lens' CreateResourceResponse (Maybe ProgressEvent) -- | The response's http status code. createResourceResponse_httpStatus :: Lens' CreateResourceResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.CreateResource.CreateResource instance GHC.Show.Show Amazonka.CloudControl.CreateResource.CreateResource instance GHC.Classes.Eq Amazonka.CloudControl.CreateResource.CreateResource instance GHC.Generics.Generic Amazonka.CloudControl.CreateResource.CreateResourceResponse instance GHC.Show.Show Amazonka.CloudControl.CreateResource.CreateResourceResponse instance GHC.Classes.Eq Amazonka.CloudControl.CreateResource.CreateResourceResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.CreateResource.CreateResource instance Control.DeepSeq.NFData Amazonka.CloudControl.CreateResource.CreateResourceResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.CreateResource.CreateResource instance Control.DeepSeq.NFData Amazonka.CloudControl.CreateResource.CreateResource instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.CreateResource.CreateResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.CreateResource.CreateResource instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.CreateResource.CreateResource instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.CreateResource.CreateResource -- | Cancels the specified resource operation request. For more -- information, see Canceling resource operation requests in the -- Amazon Web Services Cloud Control API User Guide. -- -- Only resource operations requests with a status of PENDING or -- IN_PROGRESS can be canceled. module Amazonka.CloudControl.CancelResourceRequest -- | See: newCancelResourceRequest smart constructor. data CancelResourceRequest CancelResourceRequest' :: Text -> CancelResourceRequest -- | The RequestToken of the ProgressEvent object -- returned by the resource operation request. [$sel:requestToken:CancelResourceRequest'] :: CancelResourceRequest -> Text -- | Create a value of CancelResourceRequest 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: -- -- CancelResourceRequest, -- cancelResourceRequest_requestToken - The RequestToken -- of the ProgressEvent object returned by the resource -- operation request. newCancelResourceRequest :: Text -> CancelResourceRequest -- | The RequestToken of the ProgressEvent object -- returned by the resource operation request. cancelResourceRequest_requestToken :: Lens' CancelResourceRequest Text -- | See: newCancelResourceRequestResponse smart constructor. data CancelResourceRequestResponse CancelResourceRequestResponse' :: Maybe ProgressEvent -> Int -> CancelResourceRequestResponse [$sel:progressEvent:CancelResourceRequestResponse'] :: CancelResourceRequestResponse -> Maybe ProgressEvent -- | The response's http status code. [$sel:httpStatus:CancelResourceRequestResponse'] :: CancelResourceRequestResponse -> Int -- | Create a value of CancelResourceRequestResponse 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:progressEvent:CancelResourceRequestResponse', -- cancelResourceRequestResponse_progressEvent - Undocumented -- member. -- -- $sel:httpStatus:CancelResourceRequestResponse', -- cancelResourceRequestResponse_httpStatus - The response's http -- status code. newCancelResourceRequestResponse :: Int -> CancelResourceRequestResponse -- | Undocumented member. cancelResourceRequestResponse_progressEvent :: Lens' CancelResourceRequestResponse (Maybe ProgressEvent) -- | The response's http status code. cancelResourceRequestResponse_httpStatus :: Lens' CancelResourceRequestResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance GHC.Show.Show Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance GHC.Read.Read Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance GHC.Classes.Eq Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance GHC.Generics.Generic Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequestResponse instance GHC.Show.Show Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequestResponse instance GHC.Classes.Eq Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequestResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Control.DeepSeq.NFData Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequestResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Control.DeepSeq.NFData Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.CancelResourceRequest.CancelResourceRequest -- | Updates the specified property values in the resource. -- -- You specify your resource property updates as a list of patch -- operations contained in a JSON patch document that adheres to the -- RFC 6902 - JavaScript Object Notation (JSON) Patch standard. -- -- For details on how Cloud Control API performs resource update -- operations, see Updating a resource in the Amazon Web -- Services Cloud Control API User Guide. -- -- After you have initiated a resource update request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by UpdateResource. -- -- For more information about the properties of a specific resource, -- refer to the related topic for the resource in the Resource and -- property types reference in the CloudFormation Users Guide. module Amazonka.CloudControl.UpdateResource -- | See: newUpdateResource smart constructor. data UpdateResource UpdateResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> Sensitive Text -> UpdateResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. [$sel:clientToken:UpdateResource'] :: UpdateResource -> Maybe Text -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. [$sel:roleArn:UpdateResource'] :: UpdateResource -> Maybe Text -- | 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. [$sel:typeVersionId:UpdateResource'] :: UpdateResource -> Maybe Text -- | The name of the resource type. [$sel:typeName:UpdateResource'] :: UpdateResource -> Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. [$sel:identifier:UpdateResource'] :: UpdateResource -> Text -- | 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 Amazon Web Services Cloud Control API User Guide. [$sel:patchDocument:UpdateResource'] :: UpdateResource -> Sensitive Text -- | Create a value of UpdateResource 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:clientToken:UpdateResource', -- updateResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:UpdateResource', updateResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:UpdateResource', -- updateResource_typeVersionId - 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. -- -- UpdateResource, updateResource_typeName - The name of -- the resource type. -- -- UpdateResource, updateResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:patchDocument:UpdateResource', -- updateResource_patchDocument - 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 Amazon Web Services -- Cloud Control API User Guide. newUpdateResource :: Text -> Text -> Text -> UpdateResource -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. updateResource_clientToken :: Lens' UpdateResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. updateResource_roleArn :: Lens' UpdateResource (Maybe Text) -- | 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. updateResource_typeVersionId :: Lens' UpdateResource (Maybe Text) -- | The name of the resource type. updateResource_typeName :: Lens' UpdateResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. updateResource_identifier :: Lens' UpdateResource Text -- | 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 Amazon Web Services Cloud Control API User Guide. updateResource_patchDocument :: Lens' UpdateResource Text -- | See: newUpdateResourceResponse smart constructor. data UpdateResourceResponse UpdateResourceResponse' :: Maybe ProgressEvent -> Int -> UpdateResourceResponse -- | 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. [$sel:progressEvent:UpdateResourceResponse'] :: UpdateResourceResponse -> Maybe ProgressEvent -- | The response's http status code. [$sel:httpStatus:UpdateResourceResponse'] :: UpdateResourceResponse -> Int -- | Create a value of UpdateResourceResponse 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:progressEvent:UpdateResourceResponse', -- updateResourceResponse_progressEvent - 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. -- -- $sel:httpStatus:UpdateResourceResponse', -- updateResourceResponse_httpStatus - The response's http status -- code. newUpdateResourceResponse :: Int -> UpdateResourceResponse -- | 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. updateResourceResponse_progressEvent :: Lens' UpdateResourceResponse (Maybe ProgressEvent) -- | The response's http status code. updateResourceResponse_httpStatus :: Lens' UpdateResourceResponse Int instance GHC.Generics.Generic Amazonka.CloudControl.UpdateResource.UpdateResource instance GHC.Show.Show Amazonka.CloudControl.UpdateResource.UpdateResource instance GHC.Classes.Eq Amazonka.CloudControl.UpdateResource.UpdateResource instance GHC.Generics.Generic Amazonka.CloudControl.UpdateResource.UpdateResourceResponse instance GHC.Show.Show Amazonka.CloudControl.UpdateResource.UpdateResourceResponse instance GHC.Classes.Eq Amazonka.CloudControl.UpdateResource.UpdateResourceResponse instance Amazonka.Types.AWSRequest Amazonka.CloudControl.UpdateResource.UpdateResource instance Control.DeepSeq.NFData Amazonka.CloudControl.UpdateResource.UpdateResourceResponse instance Data.Hashable.Class.Hashable Amazonka.CloudControl.UpdateResource.UpdateResource instance Control.DeepSeq.NFData Amazonka.CloudControl.UpdateResource.UpdateResource instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudControl.UpdateResource.UpdateResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudControl.UpdateResource.UpdateResource instance Amazonka.Data.Path.ToPath Amazonka.CloudControl.UpdateResource.UpdateResource instance Amazonka.Data.Query.ToQuery Amazonka.CloudControl.UpdateResource.UpdateResource module Amazonka.CloudControl.Lens -- | The RequestToken of the ProgressEvent object -- returned by the resource operation request. cancelResourceRequest_requestToken :: Lens' CancelResourceRequest Text -- | Undocumented member. cancelResourceRequestResponse_progressEvent :: Lens' CancelResourceRequestResponse (Maybe ProgressEvent) -- | The response's http status code. cancelResourceRequestResponse_httpStatus :: Lens' CancelResourceRequestResponse Int -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. createResource_clientToken :: Lens' CreateResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. createResource_roleArn :: Lens' CreateResource (Maybe Text) -- | 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. createResource_typeVersionId :: Lens' CreateResource (Maybe Text) -- | The name of the resource type. createResource_typeName :: Lens' CreateResource Text -- | Structured data format representing the desired state of the resource, -- consisting of that resource's properties and their desired values. -- -- Cloud Control API currently supports JSON as a structured data format. -- -- 
--   <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
--
createResource_desiredState :: Lens' CreateResource Text -- | Represents the current status of the resource creation request. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by CreateResource. createResourceResponse_progressEvent :: Lens' CreateResourceResponse (Maybe ProgressEvent) -- | The response's http status code. createResourceResponse_httpStatus :: Lens' CreateResourceResponse Int -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. deleteResource_clientToken :: Lens' DeleteResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. deleteResource_roleArn :: Lens' DeleteResource (Maybe Text) -- | 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. deleteResource_typeVersionId :: Lens' DeleteResource (Maybe Text) -- | The name of the resource type. deleteResource_typeName :: Lens' DeleteResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. deleteResource_identifier :: Lens' DeleteResource Text -- | Represents the current status of the resource deletion request. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. deleteResourceResponse_progressEvent :: Lens' DeleteResourceResponse (Maybe ProgressEvent) -- | The response's http status code. deleteResourceResponse_httpStatus :: Lens' DeleteResourceResponse Int -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. getResource_roleArn :: Lens' GetResource (Maybe Text) -- | 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. getResource_typeVersionId :: Lens' GetResource (Maybe Text) -- | The name of the resource type. getResource_typeName :: Lens' GetResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. getResource_identifier :: Lens' GetResource Text -- | Undocumented member. getResourceResponse_resourceDescription :: Lens' GetResourceResponse (Maybe ResourceDescription) -- | The name of the resource type. getResourceResponse_typeName :: Lens' GetResourceResponse (Maybe Text) -- | The response's http status code. getResourceResponse_httpStatus :: Lens' GetResourceResponse Int -- | A unique token used to track the progress of the resource operation -- request. -- -- Request tokens are included in the ProgressEvent type -- returned by a resource operation request. getResourceRequestStatus_requestToken :: Lens' GetResourceRequestStatus Text -- | Represents the current status of the resource operation request. getResourceRequestStatusResponse_progressEvent :: Lens' GetResourceRequestStatusResponse (Maybe ProgressEvent) -- | The response's http status code. getResourceRequestStatusResponse_httpStatus :: Lens' GetResourceRequestStatusResponse Int -- | The maximum number of results to be returned with a single call. If -- the number of available results exceeds this maximum, the response -- includes a NextToken value that you can assign to the -- NextToken request parameter to get the next set of results. -- -- The default is 20. listResourceRequests_maxResults :: Lens' ListResourceRequests (Maybe Natural) -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. listResourceRequests_nextToken :: Lens' ListResourceRequests (Maybe Text) -- | The filter criteria to apply to the requests returned. listResourceRequests_resourceRequestStatusFilter :: Lens' ListResourceRequests (Maybe ResourceRequestStatusFilter) -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. listResourceRequestsResponse_nextToken :: Lens' ListResourceRequestsResponse (Maybe Text) -- | The requests that match the specified filter criteria. listResourceRequestsResponse_resourceRequestStatusSummaries :: Lens' ListResourceRequestsResponse (Maybe [ProgressEvent]) -- | The response's http status code. listResourceRequestsResponse_httpStatus :: Lens' ListResourceRequestsResponse Int -- | Reserved. listResources_maxResults :: Lens' ListResources (Maybe Natural) -- | If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. listResources_nextToken :: Lens' ListResources (Maybe Text) -- | The resource model to use to select the resources to return. listResources_resourceModel :: Lens' ListResources (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. listResources_roleArn :: Lens' ListResources (Maybe Text) -- | 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. listResources_typeVersionId :: Lens' ListResources (Maybe Text) -- | The name of the resource type. listResources_typeName :: Lens' ListResources Text -- | If the request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text) -- | Information about the specified resources, including primary -- identifier and resource model. listResourcesResponse_resourceDescriptions :: Lens' ListResourcesResponse (Maybe [ResourceDescription]) -- | The name of the resource type. listResourcesResponse_typeName :: Lens' ListResourcesResponse (Maybe Text) -- | The response's http status code. listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int -- | A unique identifier to ensure the idempotency of the resource request. -- As a best practice, specify this token to ensure idempotency, so that -- Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. updateResource_clientToken :: Lens' UpdateResource (Maybe Text) -- | The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. updateResource_roleArn :: Lens' UpdateResource (Maybe Text) -- | 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. updateResource_typeVersionId :: Lens' UpdateResource (Maybe Text) -- | The name of the resource type. updateResource_typeName :: Lens' UpdateResource Text -- | 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 -- Amazon Web Services Cloud Control API User Guide. updateResource_identifier :: Lens' UpdateResource Text -- | 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 Amazon Web Services Cloud Control API User Guide. updateResource_patchDocument :: Lens' UpdateResource Text -- | 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. updateResourceResponse_progressEvent :: Lens' UpdateResourceResponse (Maybe ProgressEvent) -- | The response's http status code. updateResourceResponse_httpStatus :: Lens' UpdateResourceResponse Int -- | 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_errorCode :: Lens' ProgressEvent (Maybe HandlerErrorCode) -- | When the resource operation request was initiated. progressEvent_eventTime :: Lens' ProgressEvent (Maybe UTCTime) -- | 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_identifier :: Lens' ProgressEvent (Maybe Text) -- | The resource operation type. progressEvent_operation :: Lens' ProgressEvent (Maybe Operation) -- | The current status of the resource operation request. -- -- progressEvent_operationStatus :: Lens' ProgressEvent (Maybe OperationStatus) -- | The unique token representing this resource operation request. -- -- Use the RequestToken with GetResourceRequestStatus to -- return the current status of a resource operation request. progressEvent_requestToken :: Lens' ProgressEvent (Maybe Text) -- | A JSON string containing the resource model, consisting of each -- resource property and its current value. progressEvent_resourceModel :: Lens' ProgressEvent (Maybe Text) -- | When to next request the status of this resource operation request. progressEvent_retryAfter :: Lens' ProgressEvent (Maybe UTCTime) -- | Any message explaining the current status. progressEvent_statusMessage :: Lens' ProgressEvent (Maybe Text) -- | The name of the resource type used in the operation. progressEvent_typeName :: Lens' ProgressEvent (Maybe Text) -- | The primary identifier for the resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. resourceDescription_identifier :: Lens' ResourceDescription (Maybe Text) -- | A list of the resource properties and their current values. resourceDescription_properties :: Lens' ResourceDescription (Maybe Text) -- | The operation statuses to include in the filter. -- -- resourceRequestStatusFilter_operationStatuses :: Lens' ResourceRequestStatusFilter (Maybe [OperationStatus]) -- | The operation types to include in the filter. resourceRequestStatusFilter_operations :: Lens' ResourceRequestStatusFilter (Maybe [Operation]) module Amazonka.CloudControl.Waiters -- | Polls GetResourceRequestStatus every 5 seconds until a -- successful state is reached. An error is returned after 24 failed -- checks. newResourceRequestSuccess :: Wait GetResourceRequestStatus -- | Derived from API version 2021-09-30 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- For more information about Amazon Web Services Cloud Control API, see -- the Amazon Web Services Cloud Control API User Guide. module Amazonka.CloudControl -- | API version 2021-09-30 of the Amazon Cloud Control API SDK -- configuration. defaultService :: Service -- | The resource with the name requested already exists. _AlreadyExistsException :: AsError a => Fold a ServiceError -- | 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. _ClientTokenConflictException :: AsError a => Fold a ServiceError -- | The resource is currently being modified by another operation. _ConcurrentModificationException :: AsError a => Fold a ServiceError -- | Another resource operation is currently being performed on this -- resource. _ConcurrentOperationException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream service -- generated an error that doesn't map to any other handler error code. _GeneralServiceException :: AsError a => Fold a ServiceError -- | The resource handler has failed without a returning a more specific -- error code. This can include timeouts. _HandlerFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that an unexpected error occurred -- within the resource handler. _HandlerInternalFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the credentials provided by the -- user are invalid. _InvalidCredentialsException :: AsError a => Fold a ServiceError -- | The resource handler has returned that invalid input from the user has -- generated a generic exception. _InvalidRequestException :: AsError a => Fold a ServiceError -- | 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. _NetworkFailureException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream resource failed -- to complete all of its ready-state checks. _NotStabilizedException :: AsError a => Fold a ServiceError -- | One or more properties included in this resource operation are defined -- as create-only, and therefore can't be updated. _NotUpdatableException :: AsError a => Fold a ServiceError -- | 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. _PrivateTypeException :: AsError a => Fold a ServiceError -- | A resource operation with the specified request token can't be found. _RequestTokenNotFoundException :: AsError a => Fold a ServiceError -- | 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. _ResourceConflictException :: AsError a => Fold a ServiceError -- | A resource with the specified identifier can't be found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The resource handler has returned that the downstream service returned -- an internal error, typically with a 5XX HTTP status code. _ServiceInternalErrorException :: AsError a => Fold a ServiceError -- | The resource handler has returned that a non-transient resource limit -- was reached on the service side. _ServiceLimitExceededException :: AsError a => Fold a ServiceError -- | The request was denied due to request throttling. _ThrottlingException :: AsError a => Fold a ServiceError -- | The specified extension doesn't exist in the CloudFormation registry. _TypeNotFoundException :: AsError a => Fold a ServiceError -- | The specified resource doesn't support this resource operation. _UnsupportedActionException :: AsError a => Fold a ServiceError -- | Polls GetResourceRequestStatus every 5 seconds until a -- successful state is reached. An error is returned after 24 failed -- checks. newResourceRequestSuccess :: Wait GetResourceRequestStatus -- | See: newCancelResourceRequest smart constructor. data CancelResourceRequest CancelResourceRequest' :: Text -> CancelResourceRequest -- | Create a value of CancelResourceRequest 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: -- -- CancelResourceRequest, -- cancelResourceRequest_requestToken - The RequestToken -- of the ProgressEvent object returned by the resource -- operation request. newCancelResourceRequest :: Text -> CancelResourceRequest -- | See: newCancelResourceRequestResponse smart constructor. data CancelResourceRequestResponse CancelResourceRequestResponse' :: Maybe ProgressEvent -> Int -> CancelResourceRequestResponse -- | Create a value of CancelResourceRequestResponse 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:progressEvent:CancelResourceRequestResponse', -- cancelResourceRequestResponse_progressEvent - Undocumented -- member. -- -- $sel:httpStatus:CancelResourceRequestResponse', -- cancelResourceRequestResponse_httpStatus - The response's http -- status code. newCancelResourceRequestResponse :: Int -> CancelResourceRequestResponse -- | See: newCreateResource smart constructor. data CreateResource CreateResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Sensitive Text -> CreateResource -- | Create a value of CreateResource 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:clientToken:CreateResource', -- createResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:CreateResource', createResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:CreateResource', -- createResource_typeVersionId - 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. -- -- CreateResource, createResource_typeName - The name of -- the resource type. -- -- $sel:desiredState:CreateResource', -- createResource_desiredState - Structured data format -- representing the desired state of the resource, consisting of that -- resource's properties and their desired values. -- -- Cloud Control API currently supports JSON as a structured data format. -- -- 
--   <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
--
newCreateResource :: Text -> Text -> CreateResource -- | See: newCreateResourceResponse smart constructor. data CreateResourceResponse CreateResourceResponse' :: Maybe ProgressEvent -> Int -> CreateResourceResponse -- | Create a value of CreateResourceResponse 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:progressEvent:CreateResourceResponse', -- createResourceResponse_progressEvent - Represents the current -- status of the resource creation request. -- -- After you have initiated a resource creation request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by CreateResource. -- -- $sel:httpStatus:CreateResourceResponse', -- createResourceResponse_httpStatus - The response's http status -- code. newCreateResourceResponse :: Int -> CreateResourceResponse -- | See: newDeleteResource smart constructor. data DeleteResource DeleteResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> DeleteResource -- | Create a value of DeleteResource 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:clientToken:DeleteResource', -- deleteResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:DeleteResource', deleteResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:DeleteResource', -- deleteResource_typeVersionId - 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. -- -- DeleteResource, deleteResource_typeName - The name of -- the resource type. -- -- DeleteResource, deleteResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. newDeleteResource :: Text -> Text -> DeleteResource -- | See: newDeleteResourceResponse smart constructor. data DeleteResourceResponse DeleteResourceResponse' :: Maybe ProgressEvent -> Int -> DeleteResourceResponse -- | Create a value of DeleteResourceResponse 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:progressEvent:DeleteResourceResponse', -- deleteResourceResponse_progressEvent - Represents the current -- status of the resource deletion request. -- -- After you have initiated a resource deletion request, you can monitor -- the progress of your request by calling -- GetResourceRequestStatus using the RequestToken of the -- ProgressEvent returned by DeleteResource. -- -- $sel:httpStatus:DeleteResourceResponse', -- deleteResourceResponse_httpStatus - The response's http status -- code. newDeleteResourceResponse :: Int -> DeleteResourceResponse -- | See: newGetResource smart constructor. data GetResource GetResource' :: Maybe Text -> Maybe Text -> Text -> Text -> GetResource -- | Create a value of GetResource 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:roleArn:GetResource', getResource_roleArn - The -- Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:GetResource', -- getResource_typeVersionId - 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. -- -- GetResource, getResource_typeName - The name of the -- resource type. -- -- GetResource, getResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. newGetResource :: Text -> Text -> GetResource -- | See: newGetResourceResponse smart constructor. data GetResourceResponse GetResourceResponse' :: Maybe ResourceDescription -> Maybe Text -> Int -> GetResourceResponse -- | Create a value of GetResourceResponse 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:resourceDescription:GetResourceResponse', -- getResourceResponse_resourceDescription - Undocumented member. -- -- GetResource, getResourceResponse_typeName - The name of -- the resource type. -- -- $sel:httpStatus:GetResourceResponse', -- getResourceResponse_httpStatus - The response's http status -- code. newGetResourceResponse :: Int -> GetResourceResponse -- | See: newGetResourceRequestStatus smart constructor. data GetResourceRequestStatus GetResourceRequestStatus' :: Text -> GetResourceRequestStatus -- | Create a value of GetResourceRequestStatus 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: -- -- GetResourceRequestStatus, -- getResourceRequestStatus_requestToken - A unique token used to -- track the progress of the resource operation request. -- -- Request tokens are included in the ProgressEvent type -- returned by a resource operation request. newGetResourceRequestStatus :: Text -> GetResourceRequestStatus -- | See: newGetResourceRequestStatusResponse smart -- constructor. data GetResourceRequestStatusResponse GetResourceRequestStatusResponse' :: Maybe ProgressEvent -> Int -> GetResourceRequestStatusResponse -- | Create a value of GetResourceRequestStatusResponse 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:progressEvent:GetResourceRequestStatusResponse', -- getResourceRequestStatusResponse_progressEvent - Represents the -- current status of the resource operation request. -- -- $sel:httpStatus:GetResourceRequestStatusResponse', -- getResourceRequestStatusResponse_httpStatus - The response's -- http status code. newGetResourceRequestStatusResponse :: Int -> GetResourceRequestStatusResponse -- | See: newListResourceRequests smart constructor. data ListResourceRequests ListResourceRequests' :: Maybe Natural -> Maybe Text -> Maybe ResourceRequestStatusFilter -> ListResourceRequests -- | Create a value of ListResourceRequests 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:maxResults:ListResourceRequests', -- listResourceRequests_maxResults - The maximum number of results -- to be returned with a single call. If the number of available results -- exceeds this maximum, the response includes a NextToken value -- that you can assign to the NextToken request parameter to get -- the next set of results. -- -- The default is 20. -- -- ListResourceRequests, listResourceRequests_nextToken - -- If the previous paginated request didn't return all of the remaining -- results, the response object's NextToken parameter value is -- set to a token. To retrieve the next set of results, call this action -- again and assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. -- -- $sel:resourceRequestStatusFilter:ListResourceRequests', -- listResourceRequests_resourceRequestStatusFilter - The filter -- criteria to apply to the requests returned. newListResourceRequests :: ListResourceRequests -- | See: newListResourceRequestsResponse smart constructor. data ListResourceRequestsResponse ListResourceRequestsResponse' :: Maybe Text -> Maybe [ProgressEvent] -> Int -> ListResourceRequestsResponse -- | Create a value of ListResourceRequestsResponse 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: -- -- ListResourceRequests, -- listResourceRequestsResponse_nextToken - If the request doesn't -- return all of the remaining results, NextToken is set to a -- token. To retrieve the next set of results, call -- ListResources again and assign that token to the request -- object's NextToken parameter. If the request returns all -- results, NextToken is set to null. -- -- -- $sel:resourceRequestStatusSummaries:ListResourceRequestsResponse', -- listResourceRequestsResponse_resourceRequestStatusSummaries - -- The requests that match the specified filter criteria. -- -- $sel:httpStatus:ListResourceRequestsResponse', -- listResourceRequestsResponse_httpStatus - The response's http -- status code. newListResourceRequestsResponse :: Int -> ListResourceRequestsResponse -- | See: newListResources smart constructor. data ListResources ListResources' :: Maybe Natural -> Maybe Text -> Maybe (Sensitive Text) -> Maybe Text -> Maybe Text -> Text -> ListResources -- | Create a value of ListResources 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:maxResults:ListResources', listResources_maxResults -- - Reserved. -- -- ListResources, listResources_nextToken - If the previous -- paginated request didn't return all of the remaining results, the -- response object's NextToken parameter value is set to a -- token. To retrieve the next set of results, call this action again and -- assign that token to the request object's NextToken -- parameter. If there are no remaining results, the previous response -- object's NextToken parameter is set to null. -- -- ListResources, listResources_resourceModel - The -- resource model to use to select the resources to return. -- -- $sel:roleArn:ListResources', listResources_roleArn - The -- Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:ListResources', -- listResources_typeVersionId - 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. -- -- ListResources, listResources_typeName - The name of the -- resource type. newListResources :: Text -> ListResources -- | See: newListResourcesResponse smart constructor. data ListResourcesResponse ListResourcesResponse' :: Maybe Text -> Maybe [ResourceDescription] -> Maybe Text -> Int -> ListResourcesResponse -- | Create a value of ListResourcesResponse 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: -- -- ListResources, listResourcesResponse_nextToken - If the -- request doesn't return all of the remaining results, -- NextToken is set to a token. To retrieve the next set of -- results, call ListResources again and assign that token to -- the request object's NextToken parameter. If the request -- returns all results, NextToken is set to null. -- -- $sel:resourceDescriptions:ListResourcesResponse', -- listResourcesResponse_resourceDescriptions - Information about -- the specified resources, including primary identifier and resource -- model. -- -- ListResources, listResourcesResponse_typeName - The name -- of the resource type. -- -- $sel:httpStatus:ListResourcesResponse', -- listResourcesResponse_httpStatus - The response's http status -- code. newListResourcesResponse :: Int -> ListResourcesResponse -- | See: newUpdateResource smart constructor. data UpdateResource UpdateResource' :: Maybe Text -> Maybe Text -> Maybe Text -> Text -> Text -> Sensitive Text -> UpdateResource -- | Create a value of UpdateResource 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:clientToken:UpdateResource', -- updateResource_clientToken - A unique identifier to ensure the -- idempotency of the resource request. As a best practice, specify this -- token to ensure idempotency, so that Amazon Web Services 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 Amazon Web Services Cloud Control API User -- Guide. -- -- $sel:roleArn:UpdateResource', updateResource_roleArn - -- The Amazon Resource Name (ARN) of the 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 Amazon Web Services user credentials. -- -- For more information, see Specifying credentials in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:typeVersionId:UpdateResource', -- updateResource_typeVersionId - 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. -- -- UpdateResource, updateResource_typeName - The name of -- the resource type. -- -- UpdateResource, updateResource_identifier - 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 -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:patchDocument:UpdateResource', -- updateResource_patchDocument - 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 Amazon Web Services -- Cloud Control API User Guide. newUpdateResource :: Text -> Text -> Text -> UpdateResource -- | See: newUpdateResourceResponse smart constructor. data UpdateResourceResponse UpdateResourceResponse' :: Maybe ProgressEvent -> Int -> UpdateResourceResponse -- | Create a value of UpdateResourceResponse 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:progressEvent:UpdateResourceResponse', -- updateResourceResponse_progressEvent - 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. -- -- $sel:httpStatus:UpdateResourceResponse', -- updateResourceResponse_httpStatus - The response's http status -- code. newUpdateResourceResponse :: Int -> UpdateResourceResponse newtype HandlerErrorCode HandlerErrorCode' :: Text -> HandlerErrorCode [fromHandlerErrorCode] :: HandlerErrorCode -> Text pattern HandlerErrorCode_AccessDenied :: HandlerErrorCode pattern HandlerErrorCode_AlreadyExists :: HandlerErrorCode pattern HandlerErrorCode_GeneralServiceException :: HandlerErrorCode pattern HandlerErrorCode_InternalFailure :: HandlerErrorCode pattern HandlerErrorCode_InvalidCredentials :: HandlerErrorCode pattern HandlerErrorCode_InvalidRequest :: HandlerErrorCode pattern HandlerErrorCode_NetworkFailure :: HandlerErrorCode pattern HandlerErrorCode_NotFound :: HandlerErrorCode pattern HandlerErrorCode_NotStabilized :: HandlerErrorCode pattern HandlerErrorCode_NotUpdatable :: HandlerErrorCode pattern HandlerErrorCode_ResourceConflict :: HandlerErrorCode pattern HandlerErrorCode_ServiceInternalError :: HandlerErrorCode pattern HandlerErrorCode_ServiceLimitExceeded :: HandlerErrorCode pattern HandlerErrorCode_ServiceTimeout :: HandlerErrorCode pattern HandlerErrorCode_Throttling :: HandlerErrorCode newtype Operation Operation' :: Text -> Operation [fromOperation] :: Operation -> Text pattern Operation_CREATE :: Operation pattern Operation_DELETE :: Operation pattern Operation_UPDATE :: Operation newtype OperationStatus OperationStatus' :: Text -> OperationStatus [fromOperationStatus] :: OperationStatus -> Text pattern OperationStatus_CANCEL_COMPLETE :: OperationStatus pattern OperationStatus_CANCEL_IN_PROGRESS :: OperationStatus pattern OperationStatus_FAILED :: OperationStatus pattern OperationStatus_IN_PROGRESS :: OperationStatus pattern OperationStatus_PENDING :: OperationStatus pattern OperationStatus_SUCCESS :: OperationStatus -- | 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. data ProgressEvent ProgressEvent' :: Maybe HandlerErrorCode -> Maybe POSIX -> Maybe Text -> Maybe Operation -> Maybe OperationStatus -> Maybe Text -> Maybe (Sensitive Text) -> Maybe POSIX -> Maybe Text -> Maybe Text -> ProgressEvent -- | 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: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/. -- -- $sel:eventTime:ProgressEvent', progressEvent_eventTime - -- When the resource operation request was initiated. -- -- $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:operation:ProgressEvent', progressEvent_operation - -- The resource operation type. -- -- $sel:operationStatus:ProgressEvent', -- progressEvent_operationStatus - The current status of the -- resource operation request. -- -- -- -- $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:retryAfter:ProgressEvent', progressEvent_retryAfter -- - When to next request the status of this resource operation request. -- -- $sel:statusMessage:ProgressEvent', -- progressEvent_statusMessage - Any message explaining the -- current status. -- -- $sel:typeName:ProgressEvent', progressEvent_typeName - -- The name of the resource type used in the operation. newProgressEvent :: ProgressEvent -- | Represents information about a provisioned resource. -- -- See: newResourceDescription smart constructor. data ResourceDescription ResourceDescription' :: Maybe Text -> Maybe (Sensitive Text) -> ResourceDescription -- | Create a value of ResourceDescription 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:identifier:ResourceDescription', -- resourceDescription_identifier - The primary identifier for the -- resource. -- -- For more information, see Identifying resources in the -- Amazon Web Services Cloud Control API User Guide. -- -- $sel:properties:ResourceDescription', -- resourceDescription_properties - A list of the resource -- properties and their current values. newResourceDescription :: ResourceDescription -- | The filter criteria to use in determining the requests returned. -- -- See: newResourceRequestStatusFilter smart constructor. data ResourceRequestStatusFilter ResourceRequestStatusFilter' :: Maybe [OperationStatus] -> Maybe [Operation] -> ResourceRequestStatusFilter -- | Create a value of ResourceRequestStatusFilter 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:operationStatuses:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operationStatuses - The operation -- statuses to include in the filter. -- -- -- -- $sel:operations:ResourceRequestStatusFilter', -- resourceRequestStatusFilter_operations - The operation types to -- include in the filter. newResourceRequestStatusFilter :: ResourceRequestStatusFilter