The buffering options. If no value is specified, the default values for Splunk are used.
+ */ +@interface AWSFirehoseSplunkBufferingHints : AWSModel + + +/** +Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).
+ */ +@property (nonatomic, strong) NSNumber * _Nullable intervalInSeconds; + +/** +Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
+ */ +@property (nonatomic, strong) NSNumber * _Nullable sizeInMBs; + +@end + /**Describes the configuration of a destination in Splunk.
Required parameters: [HECEndpoint, HECEndpointType, HECToken, S3Configuration] @@ -3008,6 +3028,11 @@ typedef NS_ENUM(NSInteger, AWSFirehoseSplunkS3BackupMode) { @interface AWSFirehoseSplunkDestinationConfiguration : AWSModel +/** +The buffering options. If no value is specified, the default values for Splunk are used.
+ */ +@property (nonatomic, strong) AWSFirehoseSplunkBufferingHints * _Nullable bufferingHints; + /**The Amazon CloudWatch logging options for your delivery stream.
*/ @@ -3061,6 +3086,11 @@ typedef NS_ENUM(NSInteger, AWSFirehoseSplunkS3BackupMode) { @interface AWSFirehoseSplunkDestinationDescription : AWSModel +/** +The buffering options. If no value is specified, the default values for Splunk are used.
+ */ +@property (nonatomic, strong) AWSFirehoseSplunkBufferingHints * _Nullable bufferingHints; + /**The Amazon CloudWatch logging options for your delivery stream.
*/ @@ -3114,6 +3144,11 @@ typedef NS_ENUM(NSInteger, AWSFirehoseSplunkS3BackupMode) { @interface AWSFirehoseSplunkDestinationUpdate : AWSModel +/** +The buffering options. If no value is specified, the default values for Splunk are used.
+ */ +@property (nonatomic, strong) AWSFirehoseSplunkBufferingHints * _Nullable bufferingHints; + /**The Amazon CloudWatch logging options for your delivery stream.
*/ diff --git a/AWSKinesis/AWSFirehoseModel.m b/AWSKinesis/AWSFirehoseModel.m index 9dea2b9ccb5..dfced82363e 100644 --- a/AWSKinesis/AWSFirehoseModel.m +++ b/AWSKinesis/AWSFirehoseModel.m @@ -3505,6 +3505,21 @@ + (NSValueTransformer *)MSKSourceDescriptionJSONTransformer { @end +@implementation AWSFirehoseSplunkBufferingHints + ++ (BOOL)supportsSecureCoding { + return YES; +} + ++ (NSDictionary *)JSONKeyPathsByPropertyKey { + return @{ + @"intervalInSeconds" : @"IntervalInSeconds", + @"sizeInMBs" : @"SizeInMBs", + }; +} + +@end + @implementation AWSFirehoseSplunkDestinationConfiguration + (BOOL)supportsSecureCoding { @@ -3513,6 +3528,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"bufferingHints" : @"BufferingHints", @"cloudWatchLoggingOptions" : @"CloudWatchLoggingOptions", @"HECAcknowledgmentTimeoutInSeconds" : @"HECAcknowledgmentTimeoutInSeconds", @"HECEndpoint" : @"HECEndpoint", @@ -3525,6 +3541,10 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { }; } ++ (NSValueTransformer *)bufferingHintsJSONTransformer { + return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseSplunkBufferingHints class]]; +} + + (NSValueTransformer *)cloudWatchLoggingOptionsJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseCloudWatchLoggingOptions class]]; } @@ -3593,6 +3613,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"bufferingHints" : @"BufferingHints", @"cloudWatchLoggingOptions" : @"CloudWatchLoggingOptions", @"HECAcknowledgmentTimeoutInSeconds" : @"HECAcknowledgmentTimeoutInSeconds", @"HECEndpoint" : @"HECEndpoint", @@ -3605,6 +3626,10 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { }; } ++ (NSValueTransformer *)bufferingHintsJSONTransformer { + return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseSplunkBufferingHints class]]; +} + + (NSValueTransformer *)cloudWatchLoggingOptionsJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseCloudWatchLoggingOptions class]]; } @@ -3673,6 +3698,7 @@ + (BOOL)supportsSecureCoding { + (NSDictionary *)JSONKeyPathsByPropertyKey { return @{ + @"bufferingHints" : @"BufferingHints", @"cloudWatchLoggingOptions" : @"CloudWatchLoggingOptions", @"HECAcknowledgmentTimeoutInSeconds" : @"HECAcknowledgmentTimeoutInSeconds", @"HECEndpoint" : @"HECEndpoint", @@ -3685,6 +3711,10 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey { }; } ++ (NSValueTransformer *)bufferingHintsJSONTransformer { + return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseSplunkBufferingHints class]]; +} + + (NSValueTransformer *)cloudWatchLoggingOptionsJSONTransformer { return [NSValueTransformer awsmtl_JSONDictionaryTransformerWithModelClass:[AWSFirehoseCloudWatchLoggingOptions class]]; } diff --git a/AWSKinesis/AWSFirehoseResources.m b/AWSKinesis/AWSFirehoseResources.m index 7b782c54844..18e9f3b8a4e 100644 --- a/AWSKinesis/AWSFirehoseResources.m +++ b/AWSKinesis/AWSFirehoseResources.m @@ -151,6 +151,7 @@ - (NSString *)definitionString { {\"shape\":\"ResourceNotFoundException\"},\ {\"shape\":\"InvalidArgumentException\"},\ {\"shape\":\"InvalidKMSResourceException\"},\ + {\"shape\":\"InvalidSourceException\"},\ {\"shape\":\"ServiceUnavailableException\"}\ ],\ \"documentation\":\"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.
Kinesis Data Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
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 KiB 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, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
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.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
Kinesis Data Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
For information about service quota, see Amazon Kinesis Data Firehose Quota.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
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 could 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 PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts 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.
Kinesis Data Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
\",\ + \"exception\":true\ + },\ \"KMSEncryptionConfig\":{\ \"type\":\"structure\",\ \"required\":[\"AWSKMSKeyARN\"],\ @@ -3074,6 +3085,30 @@ - (NSString *)definitionString { },\ \"documentation\":\"Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
\"\ },\ + \"SplunkBufferingHints\":{\ + \"type\":\"structure\",\ + \"members\":{\ + \"IntervalInSeconds\":{\ + \"shape\":\"SplunkBufferingIntervalInSeconds\",\ + \"documentation\":\"Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).
\"\ + },\ + \"SizeInMBs\":{\ + \"shape\":\"SplunkBufferingSizeInMBs\",\ + \"documentation\":\"Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
\"\ + }\ + },\ + \"documentation\":\"The buffering options. If no value is specified, the default values for Splunk are used.
\"\ + },\ + \"SplunkBufferingIntervalInSeconds\":{\ + \"type\":\"integer\",\ + \"max\":60,\ + \"min\":0\ + },\ + \"SplunkBufferingSizeInMBs\":{\ + \"type\":\"integer\",\ + \"max\":5,\ + \"min\":1\ + },\ \"SplunkDestinationConfiguration\":{\ \"type\":\"structure\",\ \"required\":[\ @@ -3118,6 +3153,10 @@ - (NSString *)definitionString { \"CloudWatchLoggingOptions\":{\ \"shape\":\"CloudWatchLoggingOptions\",\ \"documentation\":\"The Amazon CloudWatch logging options for your delivery stream.
\"\ + },\ + \"BufferingHints\":{\ + \"shape\":\"SplunkBufferingHints\",\ + \"documentation\":\"The buffering options. If no value is specified, the default values for Splunk are used.
\"\ }\ },\ \"documentation\":\"Describes the configuration of a destination in Splunk.
\"\ @@ -3160,6 +3199,10 @@ - (NSString *)definitionString { \"CloudWatchLoggingOptions\":{\ \"shape\":\"CloudWatchLoggingOptions\",\ \"documentation\":\"The Amazon CloudWatch logging options for your delivery stream.
\"\ + },\ + \"BufferingHints\":{\ + \"shape\":\"SplunkBufferingHints\",\ + \"documentation\":\"The buffering options. If no value is specified, the default values for Splunk are used.
\"\ }\ },\ \"documentation\":\"Describes a destination in Splunk.
\"\ @@ -3202,6 +3245,10 @@ - (NSString *)definitionString { \"CloudWatchLoggingOptions\":{\ \"shape\":\"CloudWatchLoggingOptions\",\ \"documentation\":\"The Amazon CloudWatch logging options for your delivery stream.
\"\ + },\ + \"BufferingHints\":{\ + \"shape\":\"SplunkBufferingHints\",\ + \"documentation\":\"The buffering options. If no value is specified, the default values for Splunk are used.
\"\ }\ },\ \"documentation\":\"Describes an update for a destination in Splunk.
\"\ diff --git a/AWSKinesis/AWSFirehoseService.h b/AWSKinesis/AWSFirehoseService.h index 7b73487c82d..328dbc5a4cc 100644 --- a/AWSKinesis/AWSFirehoseService.h +++ b/AWSKinesis/AWSFirehoseService.h @@ -304,7 +304,7 @@ FOUNDATION_EXPORT NSString *const AWSFirehoseSDKVersion; @param request A container for the necessary parameters to execute the PutRecord service method. - @return 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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorServiceUnavailable`. + @return 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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorInvalidSource`, `AWSFirehoseErrorServiceUnavailable`. @see AWSFirehosePutRecordInput @see AWSFirehosePutRecordOutput @@ -317,7 +317,7 @@ FOUNDATION_EXPORT NSString *const AWSFirehoseSDKVersion; @param request A container for the necessary parameters to execute the PutRecord service method. @param 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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorServiceUnavailable`. + `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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorInvalidSource`, `AWSFirehoseErrorServiceUnavailable`. @see AWSFirehosePutRecordInput @see AWSFirehosePutRecordOutput @@ -329,7 +329,7 @@ FOUNDATION_EXPORT NSString *const AWSFirehoseSDKVersion; @param request A container for the necessary parameters to execute the PutRecordBatch service method. - @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSFirehosePutRecordBatchOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSFirehoseErrorDomain` domain and the following error code: `AWSFirehoseErrorResourceNotFound`, `AWSFirehoseErrorInvalidArgument`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorServiceUnavailable`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSFirehosePutRecordBatchOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSFirehoseErrorDomain` domain and the following error code: `AWSFirehoseErrorResourceNotFound`, `AWSFirehoseErrorInvalidArgument`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorInvalidSource`, `AWSFirehoseErrorServiceUnavailable`. @see AWSFirehosePutRecordBatchInput @see AWSFirehosePutRecordBatchOutput @@ -342,7 +342,7 @@ FOUNDATION_EXPORT NSString *const AWSFirehoseSDKVersion; @param request A container for the necessary parameters to execute the PutRecordBatch service method. @param 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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorServiceUnavailable`. + `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`, `AWSFirehoseErrorInvalidKMSResource`, `AWSFirehoseErrorInvalidSource`, `AWSFirehoseErrorServiceUnavailable`. @see AWSFirehosePutRecordBatchInput @see AWSFirehosePutRecordBatchOutput diff --git a/AWSKinesis/AWSFirehoseService.m b/AWSKinesis/AWSFirehoseService.m index ca2316334ec..ff420e7dba8 100644 --- a/AWSKinesis/AWSFirehoseService.m +++ b/AWSKinesis/AWSFirehoseService.m @@ -43,6 +43,7 @@ + (void)initialize { @"ConcurrentModificationException" : @(AWSFirehoseErrorConcurrentModification), @"InvalidArgumentException" : @(AWSFirehoseErrorInvalidArgument), @"InvalidKMSResourceException" : @(AWSFirehoseErrorInvalidKMSResource), + @"InvalidSourceException" : @(AWSFirehoseErrorInvalidSource), @"LimitExceededException" : @(AWSFirehoseErrorLimitExceeded), @"ResourceInUseException" : @(AWSFirehoseErrorResourceInUse), @"ResourceNotFoundException" : @(AWSFirehoseErrorResourceNotFound), diff --git a/AWSKinesisUnitTests/AWSFirehoseNSSecureCodingTests.m b/AWSKinesisUnitTests/AWSFirehoseNSSecureCodingTests.m index 1ecf3f6f823..af92a05674f 100644 --- a/AWSKinesisUnitTests/AWSFirehoseNSSecureCodingTests.m +++ b/AWSKinesisUnitTests/AWSFirehoseNSSecureCodingTests.m @@ -101,6 +101,7 @@ - (void) test_AWSFirehoseS3DestinationUpdate API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSchemaConfiguration API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSerializer API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSourceDescription API_AVAILABLE(ios(11)); +- (void) test_AWSFirehoseSplunkBufferingHints API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSplunkDestinationConfiguration API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSplunkDestinationDescription API_AVAILABLE(ios(11)); - (void) test_AWSFirehoseSplunkDestinationUpdate API_AVAILABLE(ios(11)); @@ -451,6 +452,10 @@ - (void) test_AWSFirehoseSourceDescription { [self validateSecureCodingForClass:[AWSFirehoseSourceDescription class]]; } +- (void) test_AWSFirehoseSplunkBufferingHints { + [self validateSecureCodingForClass:[AWSFirehoseSplunkBufferingHints class]]; +} + - (void) test_AWSFirehoseSplunkDestinationConfiguration { [self validateSecureCodingForClass:[AWSFirehoseSplunkDestinationConfiguration class]]; }