AWSFirehose Class Reference

Inherits from	AWSService : NSObject
Declared in	AWSFirehoseService.h AWSFirehoseService.m

`+ defaultFirehose`

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultFirehose

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let Firehose = AWSFirehose.default()

Objective-C

 AWSFirehose *Firehose = [AWSFirehose defaultFirehose];

Declared In

AWSFirehoseService.h

`+ registerFirehoseWithConfiguration:forKey:`

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerFirehoseWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

`configuration`	A service configuration object.
`key`	A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSFirehose.register(with: configuration!, forKey: "USWest2Firehose")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSFirehose registerFirehoseWithConfiguration:configuration forKey:@"USWest2Firehose"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Firehose = AWSFirehose(forKey: "USWest2Firehose")

Objective-C

 AWSFirehose *Firehose = [AWSFirehose FirehoseForKey:@"USWest2Firehose"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSFirehoseService.h

`+ FirehoseForKey:`

Retrieves the service client associated with the key. You need to call + registerFirehoseWithConfiguration:forKey: before invoking this method.

+ (instancetype)FirehoseForKey:(NSString *)key

Parameters

`key`	A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSFirehose.register(with: configuration!, forKey: "USWest2Firehose")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSFirehose registerFirehoseWithConfiguration:configuration forKey:@"USWest2Firehose"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Firehose = AWSFirehose(forKey: "USWest2Firehose")

Objective-C

 AWSFirehose *Firehose = [AWSFirehose FirehoseForKey:@"USWest2Firehose"];

Declared In

AWSFirehoseService.h

`+ removeFirehoseForKey:`

Removes the service client associated with the key and release it.

+ (void)removeFirehoseForKey:(NSString *)key

Parameters

`key`	A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSFirehoseService.h

`– createDeliveryStream:`

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per AWS Region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

- (AWSTask<AWSFirehoseCreateDeliveryStreamOutput*> *)createDeliveryStream:(AWSFirehoseCreateDeliveryStreamInput *)request

Parameters

`request`	A container for the necessary parameters to execute the CreateDeliveryStream service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehoseCreateDeliveryStreamOutput. On failed execution, task.error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorInvalidArgument, AWSFirehoseErrorLimitExceeded, AWSFirehoseErrorResourceInUse.

Declared In

AWSFirehoseService.h

`– createDeliveryStream:completionHandler:`

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per AWS Region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

- (void)createDeliveryStream:(AWSFirehoseCreateDeliveryStreamInput *)request completionHandler:(void ( ^ ) ( AWSFirehoseCreateDeliveryStreamOutput *response , NSError *error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateDeliveryStream service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorInvalidArgument, AWSFirehoseErrorLimitExceeded, AWSFirehoseErrorResourceInUse.

Declared In

AWSFirehoseService.h

`– deleteDeliveryStream:`

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

- (AWSTask<AWSFirehoseDeleteDeliveryStreamOutput*> *)deleteDeliveryStream:(AWSFirehoseDeleteDeliveryStreamInput *)request

Parameters

`request`	A container for the necessary parameters to execute the DeleteDeliveryStream service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehoseDeleteDeliveryStreamOutput. On failed execution, task.error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceInUse, AWSFirehoseErrorResourceNotFound.

Declared In

AWSFirehoseService.h

`– deleteDeliveryStream:completionHandler:`

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

- (void)deleteDeliveryStream:(AWSFirehoseDeleteDeliveryStreamInput *)request completionHandler:(void ( ^ ) ( AWSFirehoseDeleteDeliveryStreamOutput *response , NSError *error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteDeliveryStream service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceInUse, AWSFirehoseErrorResourceNotFound.

Declared In

AWSFirehoseService.h

`– describeDeliveryStream:`

Describes the specified delivery stream and gets the 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.

- (AWSTask<AWSFirehoseDescribeDeliveryStreamOutput*> *)describeDeliveryStream:(AWSFirehoseDescribeDeliveryStreamInput *)request

Parameters

`request`	A container for the necessary parameters to execute the DescribeDeliveryStream service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehoseDescribeDeliveryStreamOutput. On failed execution, task.error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceNotFound.

Declared In

AWSFirehoseService.h

`– describeDeliveryStream:completionHandler:`

Describes the specified delivery stream and gets the 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.

- (void)describeDeliveryStream:(AWSFirehoseDescribeDeliveryStreamInput *)request completionHandler:(void ( ^ ) ( AWSFirehoseDescribeDeliveryStreamOutput *response , NSError *error ))completionHandler

Parameters

`request`	A container for the necessary parameters to execute the DescribeDeliveryStream service method.
`completionHandler`	The completion handler to call when the load request is complete. `response` - A response object, or `nil` if the request failed. `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSFirehoseErrorDomain` domain and the following error code: `AWSFirehoseErrorResourceNotFound`.

Declared In

AWSFirehoseService.h

`– 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.

- (AWSTask<AWSFirehoseListDeliveryStreamsOutput*> *)listDeliveryStreams:(AWSFirehoseListDeliveryStreamsInput *)request

Parameters

`request`	A container for the necessary parameters to execute the ListDeliveryStreams service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehoseListDeliveryStreamsOutput.

Declared In

AWSFirehoseService.h

`– listDeliveryStreams:completionHandler:`

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.

- (void)listDeliveryStreams:(AWSFirehoseListDeliveryStreamsInput *)request completionHandler:(void ( ^ ) ( AWSFirehoseListDeliveryStreamsOutput *response , NSError *error ))completionHandler

Parameters

`request`	A container for the necessary parameters to execute the ListDeliveryStreams service method.
`completionHandler`	The completion handler to call when the load request is complete. `response` - A response object, or `nil` if the request failed. `error` - An error object that indicates why the request failed, or `nil` if the request was successful.

Declared In

AWSFirehoseService.h

`– listTagsForDeliveryStream:`

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

- (AWSTask<AWSFirehoseListTagsForDeliveryStreamOutput*> *)listTagsForDeliveryStream:(AWSFirehoseListTagsForDeliveryStreamInput *)request

Parameters

`request`	A container for the necessary parameters to execute the ListTagsForDeliveryStream service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehoseListTagsForDeliveryStreamOutput. On failed execution, task.error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceNotFound, AWSFirehoseErrorInvalidArgument, AWSFirehoseErrorLimitExceeded.

Declared In

AWSFirehoseService.h

`– listTagsForDeliveryStream:completionHandler:`

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

- (void)listTagsForDeliveryStream:(AWSFirehoseListTagsForDeliveryStreamInput *)request completionHandler:(void ( ^ ) ( AWSFirehoseListTagsForDeliveryStreamOutput *response , NSError *error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTagsForDeliveryStream service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceNotFound, AWSFirehoseErrorInvalidArgument, AWSFirehoseErrorLimitExceeded.

Declared In

AWSFirehoseService.h

`– putRecord:`

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Don’t concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

- (AWSTask<AWSFirehosePutRecordOutput*> *)putRecord:(AWSFirehosePutRecordInput *)request

Parameters

`request`	A container for the necessary parameters to execute the PutRecord service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSFirehosePutRecordOutput. On failed execution, task.error may contain an NSError with AWSFirehoseErrorDomain domain and the following error code: AWSFirehoseErrorResourceNotFound, AWSFirehoseErrorInvalidArgument, AWSFirehoseErrorServiceUnavailable.

Declared In

AWSFirehoseService.h

`– putRecord:completionHandler:`