Classes

The following classes are available globally.

  • AWSAbstractKinesisRecorder is an abstract class. You should not instantiate this class directly. Instead use its concrete subclasses AWSKinesisRecorder and AWSFirehoseRecorder.

    See more

    Declaration

    Objective-C

    @interface AWSAbstractKinesisRecorder

    Swift

    class AWSAbstractKinesisRecorder

  • Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonOpenSearchServerlessBufferingHints

    Swift

    class AWSFirehoseAmazonOpenSearchServerlessBufferingHints

  • Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

    Required parameters: [RoleARN, IndexName, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonOpenSearchServerlessDestinationConfiguration

    Swift

    class AWSFirehoseAmazonOpenSearchServerlessDestinationConfiguration

  • The destination description in the Serverless offering for Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonOpenSearchServerlessDestinationDescription

    Swift

    class AWSFirehoseAmazonOpenSearchServerlessDestinationDescription

  • Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonOpenSearchServerlessDestinationUpdate

    Swift

    class AWSFirehoseAmazonOpenSearchServerlessDestinationUpdate

  • Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonOpenSearchServerlessRetryOptions

    Swift

    class AWSFirehoseAmazonOpenSearchServerlessRetryOptions

  • Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonopensearchserviceBufferingHints

    Swift

    class AWSFirehoseAmazonopensearchserviceBufferingHints

  • Describes the configuration of a destination in Amazon OpenSearch Service

    Required parameters: [RoleARN, IndexName, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonopensearchserviceDestinationConfiguration

    Swift

    class AWSFirehoseAmazonopensearchserviceDestinationConfiguration

  • The destination description in Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonopensearchserviceDestinationDescription

    Swift

    class AWSFirehoseAmazonopensearchserviceDestinationDescription

  • Describes an update for a destination in Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonopensearchserviceDestinationUpdate

    Swift

    class AWSFirehoseAmazonopensearchserviceDestinationUpdate

  • Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAmazonopensearchserviceRetryOptions

    Swift

    class AWSFirehoseAmazonopensearchserviceRetryOptions

  • The authentication configuration of the Amazon MSK cluster.

    Required parameters: [RoleARN, Connectivity]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseAuthenticationConfiguration

    Swift

    class AWSFirehoseAuthenticationConfiguration

  • Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseBufferingHints

    Swift

    class AWSFirehoseBufferingHints

  • Describes the Amazon CloudWatch logging options for your delivery stream.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseCloudWatchLoggingOptions

    Swift

    class AWSFirehoseCloudWatchLoggingOptions

  • Describes a COPY command for Amazon Redshift.

    Required parameters: [DataTableName]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseReplicateCommand

    Swift

    class AWSFirehoseReplicateCommand
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseCreateDeliveryStreamInput

    Swift

    class AWSFirehoseCreateDeliveryStreamInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseCreateDeliveryStreamOutput

    Swift

    class AWSFirehoseCreateDeliveryStreamOutput

  • Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Firehose Record Format Conversion.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDataFormatConversionConfiguration

    Swift

    class AWSFirehoseDataFormatConversionConfiguration
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseDeleteDeliveryStreamInput

    Swift

    class AWSFirehoseDeleteDeliveryStreamInput

  • Declaration

    Objective-C

    @interface AWSFirehoseDeleteDeliveryStreamOutput

    Swift

    class AWSFirehoseDeleteDeliveryStreamOutput

  • Contains information about a delivery stream.

    Required parameters: [DeliveryStreamName, DeliveryStreamARN, DeliveryStreamStatus, DeliveryStreamType, VersionId, Destinations, HasMoreDestinations]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDeliveryStreamDescription

    Swift

    class AWSFirehoseDeliveryStreamDescription

  • Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDeliveryStreamEncryptionConfiguration

    Swift

    class AWSFirehoseDeliveryStreamEncryptionConfiguration

  • Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

    Required parameters: [KeyType]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDeliveryStreamEncryptionConfigurationInput

    Swift

    class AWSFirehoseDeliveryStreamEncryptionConfigurationInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseDescribeDeliveryStreamInput

    Swift

    class AWSFirehoseDescribeDeliveryStreamInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseDescribeDeliveryStreamOutput

    Swift

    class AWSFirehoseDescribeDeliveryStreamOutput

  • The deserializer you want Firehose to use for converting the input data from JSON. Firehose then serializes the data to its final format using the Serializer. Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDeserializer

    Swift

    class AWSFirehoseDeserializer

  • Describes the destination for a delivery stream.

    Required parameters: [DestinationId]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDestinationDescription

    Swift

    class AWSFirehoseDestinationDescription

  • Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

    Required parameters: [DefaultDocumentIdFormat]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDocumentIdOptions

    Swift

    class AWSFirehoseDocumentIdOptions

  • The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseDynamicPartitioningConfiguration

    Swift

    class AWSFirehoseDynamicPartitioningConfiguration

  • Describes the buffering to perform before delivering data to the Amazon ES destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseElasticsearchBufferingHints

    Swift

    class AWSFirehoseElasticsearchBufferingHints

  • Describes the configuration of a destination in Amazon ES.

    Required parameters: [RoleARN, IndexName, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseElasticsearchDestinationConfiguration

    Swift

    class AWSFirehoseElasticsearchDestinationConfiguration

  • The destination description in Amazon ES.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseElasticsearchDestinationDescription

    Swift

    class AWSFirehoseElasticsearchDestinationDescription

  • Describes an update for a destination in Amazon ES.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseElasticsearchDestinationUpdate

    Swift

    class AWSFirehoseElasticsearchDestinationUpdate

  • Configures retry behavior in case Firehose is unable to deliver documents to Amazon ES.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseElasticsearchRetryOptions

    Swift

    class AWSFirehoseElasticsearchRetryOptions

  • Describes the encryption for a destination in Amazon S3.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseEncryptionConfiguration

    Swift

    class AWSFirehoseEncryptionConfiguration

  • Describes the configuration of a destination in Amazon S3.

    Required parameters: [RoleARN, BucketARN]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseExtendedS3DestinationConfiguration

    Swift

    class AWSFirehoseExtendedS3DestinationConfiguration

  • Describes a destination in Amazon S3.

    Required parameters: [RoleARN, BucketARN, BufferingHints, CompressionFormat, EncryptionConfiguration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseExtendedS3DestinationDescription

    Swift

    class AWSFirehoseExtendedS3DestinationDescription

  • Describes an update for a destination in Amazon S3.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseExtendedS3DestinationUpdate

    Swift

    class AWSFirehoseExtendedS3DestinationUpdate

  • Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

    Required parameters: [Type, Details]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseFailureDescription

    Swift

    class AWSFirehoseFailureDescription

  • The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHiveJsonSerDe

    Swift

    class AWSFirehoseHiveJsonSerDe

  • Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointBufferingHints

    Swift

    class AWSFirehoseHttpEndpointBufferingHints

  • Describes the metadata that’s delivered to the specified HTTP endpoint destination.

    Required parameters: [AttributeName, AttributeValue]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointCommonAttribute

    Swift

    class AWSFirehoseHttpEndpointCommonAttribute

  • Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

    Required parameters: [Url]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointConfiguration

    Swift

    class AWSFirehoseHttpEndpointConfiguration

  • Describes the HTTP endpoint selected as the destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointDescription

    Swift

    class AWSFirehoseHttpEndpointDescription

  • Describes the configuration of the HTTP endpoint destination.

    Required parameters: [EndpointConfiguration, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointDestinationConfiguration

    Swift

    class AWSFirehoseHttpEndpointDestinationConfiguration

  • Describes the HTTP endpoint destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointDestinationDescription

    Swift

    class AWSFirehoseHttpEndpointDestinationDescription

  • Updates the specified HTTP endpoint destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointDestinationUpdate

    Swift

    class AWSFirehoseHttpEndpointDestinationUpdate

  • The configuration of the HTTP endpoint request.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointRequestConfiguration

    Swift

    class AWSFirehoseHttpEndpointRequestConfiguration

  • Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn’t receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseHttpEndpointRetryOptions

    Swift

    class AWSFirehoseHttpEndpointRetryOptions

  • Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseInputFormatConfiguration

    Swift

    class AWSFirehoseInputFormatConfiguration

  • Describes an encryption key for a destination in Amazon S3.

    Required parameters: [AWSKMSKeyARN]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseKMSEncryptionConfig

    Swift

    class AWSFirehoseKMSEncryptionConfig

  • The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.

    Required parameters: [KinesisStreamARN, RoleARN]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseKinesisStreamSourceConfiguration

    Swift

    class AWSFirehoseKinesisStreamSourceConfiguration

  • Details about a Kinesis data stream used as the source for a Firehose delivery stream.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseKinesisStreamSourceDescription

    Swift

    class AWSFirehoseKinesisStreamSourceDescription
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseListDeliveryStreamsInput

    Swift

    class AWSFirehoseListDeliveryStreamsInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseListDeliveryStreamsOutput

    Swift

    class AWSFirehoseListDeliveryStreamsOutput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseListTagsForDeliveryStreamInput

    Swift

    class AWSFirehoseListTagsForDeliveryStreamInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseListTagsForDeliveryStreamOutput

    Swift

    class AWSFirehoseListTagsForDeliveryStreamOutput

  • The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

    Required parameters: [MSKClusterARN, TopicName, AuthenticationConfiguration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseMSKSourceConfiguration

    Swift

    class AWSFirehoseMSKSourceConfiguration

  • Details about the Amazon MSK cluster used as the source for a Firehose delivery stream.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseMSKSourceDescription

    Swift

    class AWSFirehoseMSKSourceDescription

  • The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseOpenXJsonSerDe

    Swift

    class AWSFirehoseOpenXJsonSerDe

  • A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseOrcSerDe

    Swift

    class AWSFirehoseOrcSerDe

  • Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseOutputFormatConfiguration

    Swift

    class AWSFirehoseOutputFormatConfiguration

  • A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseParquetSerDe

    Swift

    class AWSFirehoseParquetSerDe

  • Describes a data processing configuration.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseProcessingConfiguration

    Swift

    class AWSFirehoseProcessingConfiguration

  • Describes a data processor.

    If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord.

    Required parameters: [Type]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseProcessor

    Swift

    class AWSFirehoseProcessor

  • Describes the processor parameter.

    Required parameters: [ParameterName, ParameterValue]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseProcessorParameter

    Swift

    class AWSFirehoseProcessorParameter
  • See more

    Declaration

    Objective-C

    @interface AWSFirehosePutRecordBatchInput

    Swift

    class AWSFirehosePutRecordBatchInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehosePutRecordBatchOutput

    Swift

    class AWSFirehosePutRecordBatchOutput

  • Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

    See more

    Declaration

    Objective-C

    @interface AWSFirehosePutRecordBatchResponseEntry

    Swift

    class AWSFirehosePutRecordBatchResponseEntry
  • See more

    Declaration

    Objective-C

    @interface AWSFirehosePutRecordInput

    Swift

    class AWSFirehosePutRecordInput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehosePutRecordOutput

    Swift

    class AWSFirehosePutRecordOutput

  • The unit of data in a delivery stream.

    Required parameters: [Data]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRecord

    Swift

    class AWSFirehoseRecord

  • Describes the configuration of a destination in Amazon Redshift.

    Required parameters: [RoleARN, ClusterJDBCURL, CopyCommand, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRedshiftDestinationConfiguration

    Swift

    class AWSFirehoseRedshiftDestinationConfiguration

  • Describes a destination in Amazon Redshift.

    Required parameters: [RoleARN, ClusterJDBCURL, CopyCommand, S3DestinationDescription]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRedshiftDestinationDescription

    Swift

    class AWSFirehoseRedshiftDestinationDescription

  • Describes an update for a destination in Amazon Redshift.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRedshiftDestinationUpdate

    Swift

    class AWSFirehoseRedshiftDestinationUpdate

  • Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRedshiftRetryOptions

    Swift

    class AWSFirehoseRedshiftRetryOptions

  • The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRetryOptions

    Swift

    class AWSFirehoseRetryOptions

  • Describes the configuration of a destination in Amazon S3.

    Required parameters: [RoleARN, BucketARN]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseS3DestinationConfiguration

    Swift

    class AWSFirehoseS3DestinationConfiguration

  • Describes a destination in Amazon S3.

    Required parameters: [RoleARN, BucketARN, BufferingHints, CompressionFormat, EncryptionConfiguration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseS3DestinationDescription

    Swift

    class AWSFirehoseS3DestinationDescription

  • Describes an update for a destination in Amazon S3.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseS3DestinationUpdate

    Swift

    class AWSFirehoseS3DestinationUpdate

  • Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSchemaConfiguration

    Swift

    class AWSFirehoseSchemaConfiguration

  • The structure that defines how Firehose accesses the secret.

    Required parameters: [Enabled]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSecretsManagerConfiguration

    Swift

    class AWSFirehoseSecretsManagerConfiguration

  • The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSerializer

    Swift

    class AWSFirehoseSerializer

  • Configure Snowflake destination

    Required parameters: [AccountUrl, Database, Schema, Table, RoleARN, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeDestinationConfiguration

    Swift

    class AWSFirehoseSnowflakeDestinationConfiguration

  • Optional Snowflake destination description

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeDestinationDescription

    Swift

    class AWSFirehoseSnowflakeDestinationDescription

  • Update to configuration settings

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeDestinationUpdate

    Swift

    class AWSFirehoseSnowflakeDestinationUpdate

  • Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there’s time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don’t want Firehose to retry sending data, set this value to 0.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeRetryOptions

    Swift

    class AWSFirehoseSnowflakeRetryOptions

  • Optionally configure a Snowflake role. Otherwise the default user role will be used.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeRoleConfiguration

    Swift

    class AWSFirehoseSnowflakeRoleConfiguration

  • Configure a Snowflake VPC

    Required parameters: [PrivateLinkVpceId]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSnowflakeVpcConfiguration

    Swift

    class AWSFirehoseSnowflakeVpcConfiguration

  • Details about a Kinesis data stream used as the source for a Firehose delivery stream.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSourceDescription

    Swift

    class AWSFirehoseSourceDescription

  • The buffering options. If no value is specified, the default values for Splunk are used.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSplunkBufferingHints

    Swift

    class AWSFirehoseSplunkBufferingHints

  • Describes the configuration of a destination in Splunk.

    Required parameters: [HECEndpoint, HECEndpointType, S3Configuration]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSplunkDestinationConfiguration

    Swift

    class AWSFirehoseSplunkDestinationConfiguration

  • Describes a destination in Splunk.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSplunkDestinationDescription

    Swift

    class AWSFirehoseSplunkDestinationDescription

  • Describes an update for a destination in Splunk.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSplunkDestinationUpdate

    Swift

    class AWSFirehoseSplunkDestinationUpdate

  • Configures retry behavior in case Firehose is unable to deliver documents to Splunk, or if it doesn’t receive an acknowledgment from Splunk.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseSplunkRetryOptions

    Swift

    class AWSFirehoseSplunkRetryOptions
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseStartDeliveryStreamEncryptionInput

    Swift

    class AWSFirehoseStartDeliveryStreamEncryptionInput

  • Declaration

    Objective-C

    @interface AWSFirehoseStartDeliveryStreamEncryptionOutput

    Swift

    class AWSFirehoseStartDeliveryStreamEncryptionOutput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseStopDeliveryStreamEncryptionInput

    Swift

    class AWSFirehoseStopDeliveryStreamEncryptionInput

  • Declaration

    Objective-C

    @interface AWSFirehoseStopDeliveryStreamEncryptionOutput

    Swift

    class AWSFirehoseStopDeliveryStreamEncryptionOutput

  • Metadata that you can assign to a delivery stream, consisting of a key-value pair.

    Required parameters: [Key]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseTag

    Swift

    class AWSFirehoseTag
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseTagDeliveryStreamInput

    Swift

    class AWSFirehoseTagDeliveryStreamInput

  • Declaration

    Objective-C

    @interface AWSFirehoseTagDeliveryStreamOutput

    Swift

    class AWSFirehoseTagDeliveryStreamOutput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseUntagDeliveryStreamInput

    Swift

    class AWSFirehoseUntagDeliveryStreamInput

  • Declaration

    Objective-C

    @interface AWSFirehoseUntagDeliveryStreamOutput

    Swift

    class AWSFirehoseUntagDeliveryStreamOutput
  • See more

    Declaration

    Objective-C

    @interface AWSFirehoseUpdateDestinationInput

    Swift

    class AWSFirehoseUpdateDestinationInput

  • Declaration

    Objective-C

    @interface AWSFirehoseUpdateDestinationOutput

    Swift

    class AWSFirehoseUpdateDestinationOutput

  • The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.

    Required parameters: [SubnetIds, RoleARN, SecurityGroupIds]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseVpcConfiguration

    Swift

    class AWSFirehoseVpcConfiguration

  • The details of the VPC of the Amazon ES destination.

    Required parameters: [SubnetIds, RoleARN, SecurityGroupIds, VpcId]

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseVpcConfigurationDescription

    Swift

    class AWSFirehoseVpcConfigurationDescription

  • The AWSFirehoseRecorder is a high level client meant for storing put record requests on the user’s device. This allows developers to retain requests when the device is offline. It can also increase performance and battery efficiency since the Wi-Fi or cell network does not need to be woken up as frequently. @discussion AWSFirehoseRecorder stores the requests unencrypted and does not perform additional security measures outside of what the iOS offers by default. Therefore, it is recommended not to store highly sensitive information using AWSFirehoseRecorder.

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseRecorder : AWSAbstractKinesisRecorder

    Swift

    class AWSFirehoseRecorder : AWSAbstractKinesisRecorder

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSFirehoseResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

    Swift

    class AWSFirehoseResources : NSObject

  • Amazon Data Firehose

    Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.

    Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supported destinations.

    See more

    Declaration

    Objective-C

    @interface AWSFirehose

    Swift

    class AWSFirehose

  • Represents the input for AddTagsToStream.

    Required parameters: [StreamName, Tags]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisAddTagsToStreamInput

    Swift

    class AWSKinesisAddTagsToStreamInput

  • Represents the input for CreateStream.

    Required parameters: [StreamName, ShardCount]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisCreateStreamInput

    Swift

    class AWSKinesisCreateStreamInput

  • Represents the input for DecreaseStreamRetentionPeriod.

    Required parameters: [StreamName, RetentionPeriodHours]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisDecreaseStreamRetentionPeriodInput

    Swift

    class AWSKinesisDecreaseStreamRetentionPeriodInput

  • Represents the input for DeleteStream.

    Required parameters: [StreamName]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisDeleteStreamInput

    Swift

    class AWSKinesisDeleteStreamInput

  • Declaration

    Objective-C

    @interface AWSKinesisDescribeLimitsInput

    Swift

    class AWSKinesisDescribeLimitsInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisDescribeLimitsOutput

    Swift

    class AWSKinesisDescribeLimitsOutput

  • Represents the input for DescribeStream.

    Required parameters: [StreamName]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisDescribeStreamInput

    Swift

    class AWSKinesisDescribeStreamInput

  • Represents the output for DescribeStream.

    Required parameters: [StreamDescription]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisDescribeStreamOutput

    Swift

    class AWSKinesisDescribeStreamOutput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisDescribeStreamSummaryInput

    Swift

    class AWSKinesisDescribeStreamSummaryInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisDescribeStreamSummaryOutput

    Swift

    class AWSKinesisDescribeStreamSummaryOutput

  • Represents the input for DisableEnhancedMonitoring.

    Required parameters: [StreamName, ShardLevelMetrics]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisDisableEnhancedMonitoringInput

    Swift

    class AWSKinesisDisableEnhancedMonitoringInput

  • Represents the input for EnableEnhancedMonitoring.

    Required parameters: [StreamName, ShardLevelMetrics]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisEnableEnhancedMonitoringInput

    Swift

    class AWSKinesisEnableEnhancedMonitoringInput

  • Represents enhanced metrics types.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisEnhancedMetrics

    Swift

    class AWSKinesisEnhancedMetrics

  • Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisEnhancedMonitoringOutput

    Swift

    class AWSKinesisEnhancedMonitoringOutput

  • Represents the input for GetRecords.

    Required parameters: [ShardIterator]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisGetRecordsInput

    Swift

    class AWSKinesisGetRecordsInput

  • Represents the output for GetRecords.

    Required parameters: [Records]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisGetRecordsOutput

    Swift

    class AWSKinesisGetRecordsOutput

  • Represents the input for GetShardIterator.

    Required parameters: [StreamName, ShardId, ShardIteratorType]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisGetShardIteratorInput

    Swift

    class AWSKinesisGetShardIteratorInput

  • Represents the output for GetShardIterator.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisGetShardIteratorOutput

    Swift

    class AWSKinesisGetShardIteratorOutput

  • The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

    Required parameters: [StartingHashKey, EndingHashKey]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisHashKeyRange

    Swift

    class AWSKinesisHashKeyRange

  • Represents the input for IncreaseStreamRetentionPeriod.

    Required parameters: [StreamName, RetentionPeriodHours]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisIncreaseStreamRetentionPeriodInput

    Swift

    class AWSKinesisIncreaseStreamRetentionPeriodInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisListShardsInput

    Swift

    class AWSKinesisListShardsInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisListShardsOutput

    Swift

    class AWSKinesisListShardsOutput

  • Represents the input for ListStreams.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisListStreamsInput

    Swift

    class AWSKinesisListStreamsInput

  • Represents the output for ListStreams.

    Required parameters: [StreamNames, HasMoreStreams]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisListStreamsOutput

    Swift

    class AWSKinesisListStreamsOutput

  • Represents the input for ListTagsForStream.

    Required parameters: [StreamName]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisListTagsForStreamInput

    Swift

    class AWSKinesisListTagsForStreamInput

  • Represents the output for ListTagsForStream.

    Required parameters: [Tags, HasMoreTags]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisListTagsForStreamOutput

    Swift

    class AWSKinesisListTagsForStreamOutput

  • Represents the input for MergeShards.

    Required parameters: [StreamName, ShardToMerge, AdjacentShardToMerge]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisMergeShardsInput

    Swift

    class AWSKinesisMergeShardsInput

  • Represents the input for PutRecord.

    Required parameters: [StreamName, Data, PartitionKey]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordInput

    Swift

    class AWSKinesisPutRecordInput

  • Represents the output for PutRecord.

    Required parameters: [ShardId, SequenceNumber]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordOutput

    Swift

    class AWSKinesisPutRecordOutput

  • A PutRecords request.

    Required parameters: [Records, StreamName]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordsInput

    Swift

    class AWSKinesisPutRecordsInput

  • PutRecords results.

    Required parameters: [Records]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordsOutput

    Swift

    class AWSKinesisPutRecordsOutput

  • Represents the output for PutRecords.

    Required parameters: [Data, PartitionKey]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordsRequestEntry

    Swift

    class AWSKinesisPutRecordsRequestEntry

  • Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisPutRecordsResultEntry

    Swift

    class AWSKinesisPutRecordsResultEntry

  • The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

    Required parameters: [SequenceNumber, Data, PartitionKey]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisRecord

    Swift

    class AWSKinesisRecord

  • Represents the input for RemoveTagsFromStream.

    Required parameters: [StreamName, TagKeys]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisRemoveTagsFromStreamInput

    Swift

    class AWSKinesisRemoveTagsFromStreamInput

  • The range of possible sequence numbers for the shard.

    Required parameters: [StartingSequenceNumber]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisSequenceNumberRange

    Swift

    class AWSKinesisSequenceNumberRange

  • A uniquely identified group of data records in a Kinesis data stream.

    Required parameters: [ShardId, HashKeyRange, SequenceNumberRange]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisShard

    Swift

    class AWSKinesisShard

  • Represents the input for SplitShard.

    Required parameters: [StreamName, ShardToSplit, NewStartingHashKey]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisSplitShardInput

    Swift

    class AWSKinesisSplitShardInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisStartStreamEncryptionInput

    Swift

    class AWSKinesisStartStreamEncryptionInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisStopStreamEncryptionInput

    Swift

    class AWSKinesisStopStreamEncryptionInput

  • Represents the output for DescribeStream.

    Required parameters: [StreamName, StreamARN, StreamStatus, Shards, HasMoreShards, RetentionPeriodHours, StreamCreationTimestamp, EnhancedMonitoring]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisStreamDescription

    Swift

    class AWSKinesisStreamDescription

  • Represents the output for DescribeStreamSummary

    Required parameters: [StreamName, StreamARN, StreamStatus, RetentionPeriodHours, StreamCreationTimestamp, EnhancedMonitoring, OpenShardCount]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisStreamDescriptionSummary

    Swift

    class AWSKinesisStreamDescriptionSummary

  • Metadata assigned to the stream, consisting of a key-value pair.

    Required parameters: [Key]

    See more

    Declaration

    Objective-C

    @interface AWSKinesisTag

    Swift

    class AWSKinesisTag
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisUpdateShardCountInput

    Swift

    class AWSKinesisUpdateShardCountInput
  • See more

    Declaration

    Objective-C

    @interface AWSKinesisUpdateShardCountOutput

    Swift

    class AWSKinesisUpdateShardCountOutput

  • The AWSKinesisRecorder is a high level client meant for storing put record requests on the user’s device. This allows developers to retain requests when the device is offline. It can also increase performance and battery efficiency since the Wi-Fi or cell network does not need to be woken up as frequently. @discussion AWSKinesisRecorder stores the requests unencripted and does not perform additional security measures outside of what the iOS offers by default. Therefore, it is recommended not to store highly sensitive information using AWSKinesisRecorder.

    See more

    Declaration

    Objective-C

    @interface AWSKinesisRecorder : AWSAbstractKinesisRecorder

    Swift

    class AWSKinesisRecorder : AWSAbstractKinesisRecorder

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSKinesisResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

    Swift

    class AWSKinesisResources : NSObject

  • Amazon Kinesis Data Streams Service API Reference

    Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

    See more

    Declaration

    Objective-C

    @interface AWSKinesis

    Swift

    class AWSKinesis