| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudControl
Contents
- Service Configuration
- Errors
- AlreadyExistsException
- ClientTokenConflictException
- ConcurrentModificationException
- ConcurrentOperationException
- GeneralServiceException
- HandlerFailureException
- HandlerInternalFailureException
- InvalidCredentialsException
- InvalidRequestException
- NetworkFailureException
- NotStabilizedException
- NotUpdatableException
- PrivateTypeException
- RequestTokenNotFoundException
- ResourceConflictException
- ResourceNotFoundException
- ServiceInternalErrorException
- ServiceLimitExceededException
- ThrottlingException
- TypeNotFoundException
- UnsupportedActionException
- Waiters
- Operations
- Types
Description
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.
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _ClientTokenConflictException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConcurrentOperationException :: AsError a => Fold a ServiceError
- _GeneralServiceException :: AsError a => Fold a ServiceError
- _HandlerFailureException :: AsError a => Fold a ServiceError
- _HandlerInternalFailureException :: AsError a => Fold a ServiceError
- _InvalidCredentialsException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _NetworkFailureException :: AsError a => Fold a ServiceError
- _NotStabilizedException :: AsError a => Fold a ServiceError
- _NotUpdatableException :: AsError a => Fold a ServiceError
- _PrivateTypeException :: AsError a => Fold a ServiceError
- _RequestTokenNotFoundException :: AsError a => Fold a ServiceError
- _ResourceConflictException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceInternalErrorException :: AsError a => Fold a ServiceError
- _ServiceLimitExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TypeNotFoundException :: AsError a => Fold a ServiceError
- _UnsupportedActionException :: AsError a => Fold a ServiceError
- newResourceRequestSuccess :: Wait GetResourceRequestStatus
- data CancelResourceRequest = CancelResourceRequest' Text
- newCancelResourceRequest :: Text -> CancelResourceRequest
- data CancelResourceRequestResponse = CancelResourceRequestResponse' (Maybe ProgressEvent) Int
- newCancelResourceRequestResponse :: Int -> CancelResourceRequestResponse
- data CreateResource = CreateResource' (Maybe Text) (Maybe Text) (Maybe Text) Text (Sensitive Text)
- newCreateResource :: Text -> Text -> CreateResource
- data CreateResourceResponse = CreateResourceResponse' (Maybe ProgressEvent) Int
- newCreateResourceResponse :: Int -> CreateResourceResponse
- data DeleteResource = DeleteResource' (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newDeleteResource :: Text -> Text -> DeleteResource
- data DeleteResourceResponse = DeleteResourceResponse' (Maybe ProgressEvent) Int
- newDeleteResourceResponse :: Int -> DeleteResourceResponse
- data GetResource = GetResource' (Maybe Text) (Maybe Text) Text Text
- newGetResource :: Text -> Text -> GetResource
- data GetResourceResponse = GetResourceResponse' (Maybe ResourceDescription) (Maybe Text) Int
- newGetResourceResponse :: Int -> GetResourceResponse
- data GetResourceRequestStatus = GetResourceRequestStatus' Text
- newGetResourceRequestStatus :: Text -> GetResourceRequestStatus
- data GetResourceRequestStatusResponse = GetResourceRequestStatusResponse' (Maybe ProgressEvent) Int
- newGetResourceRequestStatusResponse :: Int -> GetResourceRequestStatusResponse
- data ListResourceRequests = ListResourceRequests' (Maybe Natural) (Maybe Text) (Maybe ResourceRequestStatusFilter)
- newListResourceRequests :: ListResourceRequests
- data ListResourceRequestsResponse = ListResourceRequestsResponse' (Maybe Text) (Maybe [ProgressEvent]) Int
- newListResourceRequestsResponse :: Int -> ListResourceRequestsResponse
- data ListResources = ListResources' (Maybe Natural) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newListResources :: Text -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe Text) (Maybe [ResourceDescription]) (Maybe Text) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data UpdateResource = UpdateResource' (Maybe Text) (Maybe Text) (Maybe Text) Text Text (Sensitive Text)
- newUpdateResource :: Text -> Text -> Text -> UpdateResource
- data UpdateResourceResponse = UpdateResourceResponse' (Maybe ProgressEvent) Int
- newUpdateResourceResponse :: Int -> UpdateResourceResponse
- newtype HandlerErrorCode where
- HandlerErrorCode' { }
- 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 where
- Operation' { }
- pattern Operation_CREATE :: Operation
- pattern Operation_DELETE :: Operation
- pattern Operation_UPDATE :: Operation
- newtype OperationStatus where
- OperationStatus' { }
- 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
- data ProgressEvent = ProgressEvent' (Maybe HandlerErrorCode) (Maybe POSIX) (Maybe Text) (Maybe Operation) (Maybe OperationStatus) (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newProgressEvent :: ProgressEvent
- data ResourceDescription = ResourceDescription' (Maybe Text) (Maybe (Sensitive Text))
- newResourceDescription :: ResourceDescription
- data ResourceRequestStatusFilter = ResourceRequestStatusFilter' (Maybe [OperationStatus]) (Maybe [Operation])
- newResourceRequestStatusFilter :: ResourceRequestStatusFilter
Service Configuration
defaultService :: Service Source #
API version 2021-09-30 of the Amazon Cloud Control API SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudControl.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource with the name requested already exists.
ClientTokenConflictException
_ClientTokenConflictException :: AsError a => Fold a ServiceError Source #
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.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
The resource is currently being modified by another operation.
ConcurrentOperationException
_ConcurrentOperationException :: AsError a => Fold a ServiceError Source #
Another resource operation is currently being performed on this resource.
GeneralServiceException
_GeneralServiceException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
HandlerFailureException
_HandlerFailureException :: AsError a => Fold a ServiceError Source #
The resource handler has failed without a returning a more specific error code. This can include timeouts.
HandlerInternalFailureException
_HandlerInternalFailureException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that an unexpected error occurred within the resource handler.
InvalidCredentialsException
_InvalidCredentialsException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that the credentials provided by the user are invalid.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that invalid input from the user has generated a generic exception.
NetworkFailureException
_NetworkFailureException :: AsError a => Fold a ServiceError Source #
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.
NotStabilizedException
_NotStabilizedException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
NotUpdatableException
_NotUpdatableException :: AsError a => Fold a ServiceError Source #
One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
PrivateTypeException
_PrivateTypeException :: AsError a => Fold a ServiceError Source #
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.
RequestTokenNotFoundException
_RequestTokenNotFoundException :: AsError a => Fold a ServiceError Source #
A resource operation with the specified request token can't be found.
ResourceConflictException
_ResourceConflictException :: AsError a => Fold a ServiceError Source #
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.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource with the specified identifier can't be found.
ServiceInternalErrorException
_ServiceInternalErrorException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that the downstream service returned
an internal error, typically with a 5XX HTTP status code.
ServiceLimitExceededException
_ServiceLimitExceededException :: AsError a => Fold a ServiceError Source #
The resource handler has returned that a non-transient resource limit was reached on the service side.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
TypeNotFoundException
_TypeNotFoundException :: AsError a => Fold a ServiceError Source #
The specified extension doesn't exist in the CloudFormation registry.
UnsupportedActionException
_UnsupportedActionException :: AsError a => Fold a ServiceError Source #
The specified resource doesn't support this resource operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
ResourceRequestSuccess
newResourceRequestSuccess :: Wait GetResourceRequestStatus Source #
Polls GetResourceRequestStatus every 5 seconds until a successful state is reached. An error is returned after 24 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelResourceRequest
data CancelResourceRequest Source #
See: newCancelResourceRequest smart constructor.
Constructors
| CancelResourceRequest' Text |
Instances
newCancelResourceRequest Source #
Arguments
| :: 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.
data CancelResourceRequestResponse Source #
See: newCancelResourceRequestResponse smart constructor.
Constructors
| CancelResourceRequestResponse' (Maybe ProgressEvent) Int |
Instances
newCancelResourceRequestResponse Source #
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.
CreateResource
data CreateResource Source #
See: newCreateResource smart constructor.
Instances
Arguments
| :: Text | |
| -> 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>
data CreateResourceResponse Source #
See: newCreateResourceResponse smart constructor.
Constructors
| CreateResourceResponse' (Maybe ProgressEvent) Int |
Instances
newCreateResourceResponse Source #
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.
DeleteResource
data DeleteResource Source #
See: newDeleteResource smart constructor.
Instances
Arguments
| :: 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.
data DeleteResourceResponse Source #
See: newDeleteResourceResponse smart constructor.
Constructors
| DeleteResourceResponse' (Maybe ProgressEvent) Int |
Instances
newDeleteResourceResponse Source #
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.
GetResource
data GetResource Source #
See: newGetResource smart constructor.
Instances
Arguments
| :: 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.
data GetResourceResponse Source #
See: newGetResourceResponse smart constructor.
Constructors
| GetResourceResponse' (Maybe ResourceDescription) (Maybe Text) Int |
Instances
newGetResourceResponse Source #
Arguments
| :: 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.
GetResourceRequestStatus
data GetResourceRequestStatus Source #
See: newGetResourceRequestStatus smart constructor.
Constructors
| GetResourceRequestStatus' Text |
Instances
newGetResourceRequestStatus Source #
Arguments
| :: 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.
data GetResourceRequestStatusResponse Source #
See: newGetResourceRequestStatusResponse smart constructor.
Constructors
| GetResourceRequestStatusResponse' (Maybe ProgressEvent) Int |
Instances
newGetResourceRequestStatusResponse Source #
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.
ListResourceRequests (Paginated)
data ListResourceRequests Source #
See: newListResourceRequests smart constructor.
Constructors
| ListResourceRequests' (Maybe Natural) (Maybe Text) (Maybe ResourceRequestStatusFilter) |
Instances
newListResourceRequests :: ListResourceRequests Source #
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.
data ListResourceRequestsResponse Source #
See: newListResourceRequestsResponse smart constructor.
Constructors
| ListResourceRequestsResponse' (Maybe Text) (Maybe [ProgressEvent]) Int |
Instances
newListResourceRequestsResponse Source #
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.
ListResources (Paginated)
data ListResources Source #
See: newListResources smart constructor.
Constructors
| ListResources' (Maybe Natural) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: 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.
data ListResourcesResponse Source #
See: newListResourcesResponse smart constructor.
Constructors
| ListResourcesResponse' (Maybe Text) (Maybe [ResourceDescription]) (Maybe Text) Int |
Instances
newListResourcesResponse Source #
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.
UpdateResource
data UpdateResource Source #
See: newUpdateResource smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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.
data UpdateResourceResponse Source #
See: newUpdateResourceResponse smart constructor.
Constructors
| UpdateResourceResponse' (Maybe ProgressEvent) Int |
Instances
newUpdateResourceResponse Source #
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.
Types
HandlerErrorCode
newtype HandlerErrorCode Source #
Constructors
| HandlerErrorCode' | |
Fields | |
Bundled Patterns
| 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 |
Instances
Operation
Constructors
| Operation' | |
Fields | |
Bundled Patterns
| pattern Operation_CREATE :: Operation | |
| pattern Operation_DELETE :: Operation | |
| pattern Operation_UPDATE :: Operation |
Instances
OperationStatus
newtype OperationStatus Source #
Constructors
| OperationStatus' | |
Fields | |
Bundled Patterns
| 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 |
Instances
ProgressEvent
data ProgressEvent Source #
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.
See: newProgressEvent smart constructor.
Constructors
| ProgressEvent' (Maybe HandlerErrorCode) (Maybe POSIX) (Maybe Text) (Maybe Operation) (Maybe OperationStatus) (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newProgressEvent :: ProgressEvent Source #
Create a value of ProgressEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel: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.
PENDING: The resource operation hasn't yet started.IN_PROGRESS: The resource operation is currently in progress.SUCCESS: The resource operation has successfully completed.FAILED: The resource operation has failed. Refer to the error code and status message for more information.CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.CANCEL_COMPLETE: The resource operation has been canceled.
$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.
ResourceDescription
data ResourceDescription Source #
Represents information about a provisioned resource.
See: newResourceDescription smart constructor.
Instances
newResourceDescription :: ResourceDescription Source #
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.
ResourceRequestStatusFilter
data ResourceRequestStatusFilter Source #
The filter criteria to use in determining the requests returned.
See: newResourceRequestStatusFilter smart constructor.
Constructors
| ResourceRequestStatusFilter' (Maybe [OperationStatus]) (Maybe [Operation]) |
Instances
newResourceRequestStatusFilter :: ResourceRequestStatusFilter Source #
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.
PENDING: The operation has been requested, but not yet initiated.IN_PROGRESS: The operation is in progress.SUCCESS: The operation completed.FAILED: The operation failed.CANCEL_IN_PROGRESS: The operation is in the process of being canceled.CANCEL_COMPLETE: The operation has been canceled.
$sel:operations:ResourceRequestStatusFilter', resourceRequestStatusFilter_operations - The operation types to include in the filter.