Request Parameters
The request accepts the following data in JSON format.
AllowForceDelete (p. 16)
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.
Type: Boolean Required: No
DeliveryStreamName (p. 16)
The name of the delivery stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_.-]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 181).
ResourceInUseException
The resource is already in use and not available for this operation.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 400
Examples
Example
The following JSON example deletes a delivery stream named exampleStreamName.
Sample Request
POST / HTTP/1.1
Host: firehose.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1 Authorization: <AuthParams>
Connection: Keep-Alive X-Amz-Date: <Date>
X-Amz-Target: Firehose_20150804.DeleteDeliveryStream { "DeliveryStreamName": "exampleStreamName"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes>
Date: <Date>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDeliveryStream
DescribeDeliveryStream
Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.
If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream (p. 3) again on it. However, you can invoke the DeleteDeliveryStream (p. 16) operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking
DeleteDeliveryStream (p. 16) again but with DeleteDeliveryStream:AllowForceDelete (p. 16) set to true.
Request Syntax
{ "DeliveryStreamName": "string",
"ExclusiveStartDestinationId": "string", "Limit": number
}
Request Parameters
The request accepts the following data in JSON format.
DeliveryStreamName (p. 19)
The name of the delivery stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_.-]+
Required: Yes
ExclusiveStartDestinationId (p. 19)
The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: [a-zA-Z0-9-]+
Required: No Limit (p. 19)
The limit on the number of destinations to return. You can have one destination per delivery stream.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
Response Syntax
Response Syntax
{ "DeliveryStreamDescription": { "CreateTimestamp": number, "DeliveryStreamARN": "string",
"DeliveryStreamEncryptionConfiguration": { "FailureDescription": {
"DeliveryStreamName": "string", "DeliveryStreamStatus": "string", "DeliveryStreamType": "string", "Destinations": [
{
"AmazonopensearchserviceDestinationDescription": { "BufferingHints": {
Response Syntax
Response Syntax
Response Syntax
Response Syntax
Response Syntax
Response Syntax
Response Elements
"HasMoreDestinations": boolean, "LastUpdateTimestamp": number, "Source": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DeliveryStreamDescription (p. 20)
Information about the delivery stream.
Type: DeliveryStreamDescription (p. 86) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 181).
ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 400
Examples
Examples
Example
The following JSON example describes a delivery stream.
Sample Request
"DeliveryStreamName": "exampleStreamName"
}
"DeliveryStreamDescription": { "DeliveryStreamType": "DirectPut", "HasMoreDestinations": false, "VersionId": "1",
"CreateTimestamp": 1517595920.596,
"DeliveryStreamARN": "arn:aws:firehose:us-east-1:111222333444:deliverystream/
exampleStreamName",
"DeliveryStreamStatus": "ACTIVE",
"DeliveryStreamName": "exampleStreamName", "DeliveryStreamEncryptionConfiguration": { "Status": "DISABLED"
},
"Destinations": [ {
"DestinationId": "destinationId-000000000001", "ExtendedS3DestinationDescription": {
"RoleARN": "arn:aws:iam::111222333444:role/exampleStreamName", "Prefix": "",
"CompressionFormat": "UNCOMPRESSED", "S3BackupMode": "Disabled",
"CloudWatchLoggingOptions": { "Enabled": true,
"LogStreamName": "S3Delivery",
"LogGroupName": "/aws/kinesisfirehose/exampleStreamName"
},
See Also
"RoleARN": "arn:aws:iam::111222333444:role/exampleStreamName", "Prefix": "",
"CompressionFormat": "UNCOMPRESSED", "CloudWatchLoggingOptions": {
"Enabled": true,
"LogStreamName": "S3Delivery",
"LogGroupName": "/aws/kinesisfirehose/exampleStreamName"
},
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListDeliveryStreams
ListDeliveryStreams
Lists your delivery streams in alphabetical order of their names.
The number of delivery streams might be too large to return using a single call to
ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of
HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.
Request Syntax
{ "DeliveryStreamType": "string",
"ExclusiveStartDeliveryStreamName": "string", "Limit": number
}
Request Parameters
The request accepts the following data in JSON format.
DeliveryStreamType (p. 30)
The delivery stream type. This can be one of the following values:
• DirectPut: Provider applications access the delivery stream directly.
• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
Type: String
Valid Values: DirectPut | KinesisStreamAsSource Required: No
ExclusiveStartDeliveryStreamName (p. 30)
The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_.-]+
Required: No Limit (p. 30)
The maximum number of delivery streams to list. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Response Syntax
Required: No
Response Syntax
{
"DeliveryStreamNames": [ "string" ], "HasMoreDeliveryStreams": boolean }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DeliveryStreamNames (p. 31)
The names of the delivery streams.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_.-]+
HasMoreDeliveryStreams (p. 31)
Indicates whether there are more delivery streams available to list.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors (p. 181).
Examples
Example
The following JSON example lists up to three delivery streams configured for DirectPut.
The response indicates that there are more DirectPut delivery streams to be listed. To list the remaining DirectPut delivery streams, set DeliveryStreamType to DirectPut and
ExclusiveStartDeliveryStreamName to last_stream_in_first_listing, and then run the operation again.
Sample Request
POST / HTTP/1.1
Host: firehose.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1 Authorization: <AuthParams>
Connection: Keep-Alive X-Amz-Date: <Date>
See Also
X-Amz-Target: Firehose_20150804.ListDeliveryStreams { "DeliveryStreamType": "DirectPut",
"Limit": 3 }
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes>
Date: <Date>
{ "DeliveryStreamNames": [ "some_delivery_stream",
"another_example_delivery_stream", "last_stream_in_first_listing"
],
"HasMoreDeliveryStreams": true }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForDeliveryStream
ListTagsForDeliveryStream
Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.
Request Syntax
{
"DeliveryStreamName": "string", "ExclusiveStartTagKey": "string", "Limit": number
}
Request Parameters
The request accepts the following data in JSON format.
DeliveryStreamName (p. 33)
The name of the delivery stream whose tags you want to list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_.-]+
Required: Yes
ExclusiveStartTagKey (p. 33)
The key to use as the starting point for the list of tags. If you set this parameter,
ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
Required: No Limit (p. 33)
The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
Response Syntax
{
Response Elements
"HasMoreTags": boolean, "Tags": [
{
"Key": "string", "Value": "string"
} ]}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
HasMoreTags (p. 33)
If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.
Type: Boolean Tags (p. 33)
A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
Type: Array of Tag (p. 176) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 181).
InvalidArgumentException
The specified input parameter has a value that is not valid.
HTTP Status Code: 400 LimitExceededException
You have already reached the limit for a requested resource.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 400