API version 2021-09-30 of the Amazon Cloud Control API SDK configuration.

The specified extension does not exist in the CloudFormation registry.

The resource handler has returned that the downstream service generated an error that does not map to any other handler error code.

The resource handler has failed without a returning a more specific error code. This can include timeouts.

The resource handler has returned that invalid input from the user has generated a generic exception.

Cloud Control API has not 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.

The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

The resource handler has returned that an unexpected error occurred within the resource handler.

The specified client token has already been used in another resource request.

It is best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

A resource operation with the specified request token cannot be found.

The resource handler has returned that the request could not be completed due to networking issues, such as a failure to receive a response from the server.

The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

One or more properties included in this resource operation are defined as create-only, and therefore cannot be updated.

The specified resource does not support this resource operation.

The resource handler has returned that a non-transient resource limit was reached on the service side.

The request was denied due to request throttling.

The resource is currently being modified by another operation.

The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and cannot be acted upon until that operation is finished.

The resource handler has returned that the credentials provided by the user are invalid.

A resource with the specified identifier cannot be found.

Another resource operation is currently being performed on this resource.

The resource with the name requested already exists.

Polls GetResourceRequestStatus every 5 seconds until a successful state is reached. An error is returned after 720 failed checks.

See: newGetResource smart constructor.

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

$sel:roleArn:GetResource', getResource_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) 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:typeName:GetResource', getResource_typeName - The name of the resource type.

$sel:identifier: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.

See: newGetResourceResponse smart constructor.

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:typeName:GetResource', getResourceResponse_typeName - The name of the resource type.

$sel:resourceDescription:GetResourceResponse', getResourceResponse_resourceDescription - Undocumented member.

$sel:httpStatus:GetResourceResponse', getResourceResponse_httpStatus - The response's http status code.

See: newListResourceRequests smart constructor.

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:nextToken: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.

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

See: newListResourceRequestsResponse smart constructor.

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:

$sel:resourceRequestStatusSummaries:ListResourceRequestsResponse', listResourceRequestsResponse_resourceRequestStatusSummaries - The requests that match the specified filter criteria.

$sel:nextToken: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:httpStatus:ListResourceRequestsResponse', listResourceRequestsResponse_httpStatus - The response's http status code.

See: newCancelResourceRequest smart constructor.

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:

$sel:requestToken:CancelResourceRequest', cancelResourceRequest_requestToken - The RequestToken of the ProgressEvent object returned by the resource operation request.

See: newCancelResourceRequestResponse smart constructor.

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.

See: newDeleteResource smart constructor.

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

$sel:roleArn:DeleteResource', deleteResource_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) 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:typeName:DeleteResource', deleteResource_typeName - The name of the resource type.

$sel:identifier: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.

See: newDeleteResourceResponse smart constructor.

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.

See: newUpdateResource smart constructor.

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

$sel:roleArn:UpdateResource', updateResource_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) 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:typeName:UpdateResource', updateResource_typeName - The name of the resource type.

$sel:identifier: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.

See: newUpdateResourceResponse smart constructor.

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.

See: newListResources smart constructor.

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:resourceModel:ListResources', listResources_resourceModel - The resource model to use to select the resources to return.

$sel:nextToken: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.

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

$sel:maxResults:ListResources', listResources_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.

$sel:roleArn:ListResources', listResources_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) 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:typeName:ListResources', listResources_typeName - The name of the resource type.

See: newListResourcesResponse smart constructor.

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:

$sel:resourceDescriptions:ListResourcesResponse', listResourcesResponse_resourceDescriptions - Information about the specified resources, including primary identifier and resource model.

$sel:typeName:ListResources', listResourcesResponse_typeName - The name of the resource type.

$sel:nextToken: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:httpStatus:ListResourcesResponse', listResourcesResponse_httpStatus - The response's http status code.

See: newCreateResource smart constructor.

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

$sel:roleArn:CreateResource', createResource_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) 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:typeName: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.

Specify the desired state as one of the following:

• A JSON blob
• A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

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 Amazon Web Services CloudFormation Users Guide.

See: newCreateResourceResponse smart constructor.

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.

See: newGetResourceRequestStatus smart constructor.

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:

$sel:requestToken: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.

See: newGetResourceRequestStatusResponse smart constructor.

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.