Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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
.
Synopsis
- data DeleteResource = DeleteResource' {
- clientToken :: Maybe Text
- typeVersionId :: Maybe Text
- roleArn :: Maybe Text
- typeName :: Text
- identifier :: Text
- newDeleteResource :: Text -> Text -> DeleteResource
- deleteResource_clientToken :: Lens' DeleteResource (Maybe Text)
- deleteResource_typeVersionId :: Lens' DeleteResource (Maybe Text)
- deleteResource_roleArn :: Lens' DeleteResource (Maybe Text)
- deleteResource_typeName :: Lens' DeleteResource Text
- deleteResource_identifier :: Lens' DeleteResource Text
- data DeleteResourceResponse = DeleteResourceResponse' {}
- newDeleteResourceResponse :: Int -> DeleteResourceResponse
- deleteResourceResponse_progressEvent :: Lens' DeleteResourceResponse (Maybe ProgressEvent)
- deleteResourceResponse_httpStatus :: Lens' DeleteResourceResponse Int
Creating a Request
data DeleteResource Source #
See: newDeleteResource
smart constructor.
DeleteResource' | |
|
Instances
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.
Request Lenses
deleteResource_clientToken :: Lens' DeleteResource (Maybe Text) Source #
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_typeVersionId :: Lens' DeleteResource (Maybe Text) Source #
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_roleArn :: Lens' DeleteResource (Maybe Text) Source #
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.
deleteResource_typeName :: Lens' DeleteResource Text Source #
The name of the resource type.
deleteResource_identifier :: Lens' DeleteResource Text Source #
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.
Destructuring the Response
data DeleteResourceResponse Source #
See: newDeleteResourceResponse
smart constructor.
DeleteResourceResponse' | |
|
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.
Response Lenses
deleteResourceResponse_progressEvent :: Lens' DeleteResourceResponse (Maybe ProgressEvent) Source #
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_httpStatus :: Lens' DeleteResourceResponse Int Source #
The response's http status code.