| 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 |
Amazonka.Firehose.DeleteDeliveryStream
Description
Deletes a delivery stream and its data.
To check the state of a delivery stream, use DescribeDeliveryStream. You
can delete a delivery stream only if it is in one of the following
states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED.
You can't delete a delivery stream that is in the CREATING state.
While the deletion request is in process, the delivery stream is in the
DELETING state.
While the delivery stream is in the DELETING state, the service might
continue to accept records, but it doesn't make any guarantees with
respect to delivering the data. Therefore, as a best practice, first
stop any applications that are sending records before you delete a
delivery stream.
Synopsis
- data DeleteDeliveryStream = DeleteDeliveryStream' {}
- newDeleteDeliveryStream :: Text -> DeleteDeliveryStream
- deleteDeliveryStream_allowForceDelete :: Lens' DeleteDeliveryStream (Maybe Bool)
- deleteDeliveryStream_deliveryStreamName :: Lens' DeleteDeliveryStream Text
- data DeleteDeliveryStreamResponse = DeleteDeliveryStreamResponse' {
- httpStatus :: Int
- newDeleteDeliveryStreamResponse :: Int -> DeleteDeliveryStreamResponse
- deleteDeliveryStreamResponse_httpStatus :: Lens' DeleteDeliveryStreamResponse Int
Creating a Request
data DeleteDeliveryStream Source #
See: newDeleteDeliveryStream smart constructor.
Constructors
| DeleteDeliveryStream' | |
Fields
| |
Instances
newDeleteDeliveryStream Source #
Create a value of DeleteDeliveryStream 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:allowForceDelete:DeleteDeliveryStream', deleteDeliveryStream_allowForceDelete - Set this to true if you want to delete the delivery stream even if
Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis
Data Firehose might be unable to retire the grant due to a customer
error, such as when the CMK or the grant are in an invalid state. If you
force deletion, you can then use the
RevokeGrant
operation to revoke the grant you gave to Kinesis Data Firehose. If a
failure to retire the grant happens due to an AWS KMS issue, Kinesis
Data Firehose keeps retrying the delete operation.
The default value is false.
$sel:deliveryStreamName:DeleteDeliveryStream', deleteDeliveryStream_deliveryStreamName - The name of the delivery stream.
Request Lenses
deleteDeliveryStream_allowForceDelete :: Lens' DeleteDeliveryStream (Maybe Bool) Source #
Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete operation.
The default value is false.
deleteDeliveryStream_deliveryStreamName :: Lens' DeleteDeliveryStream Text Source #
The name of the delivery stream.
Destructuring the Response
data DeleteDeliveryStreamResponse Source #
See: newDeleteDeliveryStreamResponse smart constructor.
Constructors
| DeleteDeliveryStreamResponse' | |
Fields
| |
Instances
newDeleteDeliveryStreamResponse Source #
Create a value of DeleteDeliveryStreamResponse 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:httpStatus:DeleteDeliveryStreamResponse', deleteDeliveryStreamResponse_httpStatus - The response's http status code.
Response Lenses
deleteDeliveryStreamResponse_httpStatus :: Lens' DeleteDeliveryStreamResponse Int Source #
The response's http status code.