Struct aws_sdk_firehose::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Kinesis Firehose

Client for invoking operations on Amazon Kinesis Firehose. Each operation on Amazon Kinesis Firehose is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_firehose::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_firehose::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_firehose::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_delivery_stream(&self) -> CreateDeliveryStream

Constructs a fluent builder for the CreateDeliveryStream operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
- delivery_stream_type(DeliveryStreamType) / set_delivery_stream_type(Option<DeliveryStreamType>):
 The delivery stream type. This parameter 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.
- kinesis_stream_source_configuration(KinesisStreamSourceConfiguration) / set_kinesis_stream_source_configuration(Option<KinesisStreamSourceConfiguration>):
 When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
- delivery_stream_encryption_configuration_input(DeliveryStreamEncryptionConfigurationInput) / set_delivery_stream_encryption_configuration_input(Option<DeliveryStreamEncryptionConfigurationInput>):
 Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
- s3_destination_configuration(S3DestinationConfiguration) / set_s3_destination_configuration(Option<S3DestinationConfiguration>):
 [Deprecated] The destination in Amazon S3. You can specify only one destination.
- extended_s3_destination_configuration(ExtendedS3DestinationConfiguration) / set_extended_s3_destination_configuration(Option<ExtendedS3DestinationConfiguration>):
 The destination in Amazon S3. You can specify only one destination.
- redshift_destination_configuration(RedshiftDestinationConfiguration) / set_redshift_destination_configuration(Option<RedshiftDestinationConfiguration>):
 The destination in Amazon Redshift. You can specify only one destination.
- elasticsearch_destination_configuration(ElasticsearchDestinationConfiguration) / set_elasticsearch_destination_configuration(Option<ElasticsearchDestinationConfiguration>):
 The destination in Amazon ES. You can specify only one destination.
- amazonopensearchservice_destination_configuration(AmazonopensearchserviceDestinationConfiguration) / set_amazonopensearchservice_destination_configuration(Option<AmazonopensearchserviceDestinationConfiguration>): (undocumented)
- splunk_destination_configuration(SplunkDestinationConfiguration) / set_splunk_destination_configuration(Option<SplunkDestinationConfiguration>):
 The destination in Splunk. You can specify only one destination.
- http_endpoint_destination_configuration(HttpEndpointDestinationConfiguration) / set_http_endpoint_destination_configuration(Option<HttpEndpointDestinationConfiguration>):
 Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
 
 You can specify up to 50 tags when creating a delivery stream.
On success, responds with CreateDeliveryStreamOutput with field(s):
- delivery_stream_arn(Option<String>):
 The ARN of the delivery stream.
On failure, responds with SdkError<CreateDeliveryStreamError>

source

pub fn delete_delivery_stream(&self) -> DeleteDeliveryStream

Constructs a fluent builder for the DeleteDeliveryStream operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream.
- allow_force_delete(bool) / set_allow_force_delete(Option<bool>):
 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.
On success, responds with DeleteDeliveryStreamOutput
On failure, responds with SdkError<DeleteDeliveryStreamError>

source

pub fn describe_delivery_stream(&self) -> DescribeDeliveryStream

Constructs a fluent builder for the DescribeDeliveryStream operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream.
- limit(i32) / set_limit(Option<i32>):
 The limit on the number of destinations to return. You can have one destination per delivery stream.
- exclusive_start_destination_id(impl Into<String>) / set_exclusive_start_destination_id(Option<String>):
 The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
On success, responds with DescribeDeliveryStreamOutput with field(s):
- delivery_stream_description(Option<DeliveryStreamDescription>):
 Information about the delivery stream.
On failure, responds with SdkError<DescribeDeliveryStreamError>

source

pub fn list_delivery_streams(&self) -> ListDeliveryStreams

Constructs a fluent builder for the ListDeliveryStreams operation.

The fluent builder is configurable:
- limit(i32) / set_limit(Option<i32>):
 The maximum number of delivery streams to list. The default value is 10.
- delivery_stream_type(DeliveryStreamType) / set_delivery_stream_type(Option<DeliveryStreamType>):
 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.
- exclusive_start_delivery_stream_name(impl Into<String>) / set_exclusive_start_delivery_stream_name(Option<String>):
 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.
On success, responds with ListDeliveryStreamsOutput with field(s):
- delivery_stream_names(Option<Vec<String>>):
 The names of the delivery streams.
- has_more_delivery_streams(Option<bool>):
 Indicates whether there are more delivery streams available to list.
On failure, responds with SdkError<ListDeliveryStreamsError>

source

pub fn list_tags_for_delivery_stream(&self) -> ListTagsForDeliveryStream

Constructs a fluent builder for the ListTagsForDeliveryStream operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream whose tags you want to list.
- exclusive_start_tag_key(impl Into<String>) / set_exclusive_start_tag_key(Option<String>):
 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.
- limit(i32) / set_limit(Option<i32>):
 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.
On success, responds with ListTagsForDeliveryStreamOutput with field(s):
- tags(Option<Vec<Tag>>):
 A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
- has_more_tags(Option<bool>):
 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.
On failure, responds with SdkError<ListTagsForDeliveryStreamError>

source

pub fn put_record(&self) -> PutRecord

Constructs a fluent builder for the PutRecord operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream.
- record(Record) / set_record(Option<Record>):
 The record.
On success, responds with PutRecordOutput with field(s):
- record_id(Option<String>):
 The ID of the record.
- encrypted(Option<bool>):
 Indicates whether server-side encryption (SSE) was enabled during this operation.
On failure, responds with SdkError<PutRecordError>

source

pub fn put_record_batch(&self) -> PutRecordBatch

Constructs a fluent builder for the PutRecordBatch operation.

The fluent builder is configurable:
- delivery_stream_name(impl Into<String>) / set_delivery_stream_name(Option<String>):
 The name of the delivery stream.
- records(Vec<Record>) / set_records(Option<Vec<Record>>):
 One or more records.
On success, responds with PutRecordBatchOutput with field(s):
- failed_put_count(Option<i32>):
 The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend.
- encrypted(Option<bool>):
 Indicates whether server-side encryption (SSE) was enabled during this operation.
- request_responses(Option<Vec<PutRecordBatchResponseEntry>>):
 The results array. For each record, the index of the response element is the same as the index used in the request array.
On failure, responds with SdkError<PutRecordBatchError>