String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
Integer shardCount
DefaultShardLimit;
Constraints:
Range: 1 - 100000
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 10000
String exclusiveStartShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
StreamDescription streamDescription
String shardIterator
Constraints:
Length: 1 - 512
Integer limit
InvalidArgumentException
.
Constraints:
Range: 1 - 10000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
String nextShardIterator
null
, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
Long millisBehindLatest
Constraints:
Range: 0 -
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardIteratorType
The following are the valid shard iterator types:
Constraints:
Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST
String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardIterator
Constraints:
Length: 1 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> streamNames
ListStreams
request.Boolean hasMoreStreams
true
, there are more streams available to list.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String exclusiveStartTagKey
ListTagsForStream
gets all tags that
occur after ExclusiveStartTagKey
.
Constraints:
Length: 1 - 128
Integer limit
HasMoreTags
is
set to true
. To list additional tags, set
ExclusiveStartTagKey
to the last key in the response.
Constraints:
Range: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
StreamName
, starting with
the first tag after ExclusiveStartTagKey
and up to the
specified Limit
.
Constraints:
Length: 0 -
Boolean hasMoreTags
true
, more tags are available. To request
additional tags, set ExclusiveStartTagKey
to the key of
the last tag returned.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String adjacentShardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
ByteBuffer data
Constraints:
Length: 0 - 1048576
String partitionKey
Constraints:
Length: 1 - 256
String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
String sequenceNumberForOrdering
SequenceNumberForOrdering
of record n to the
sequence number of record n-1 (as returned in the result when
putting record n-1). If this parameter is not set, records will
be coarsely ordered based on arrival time.
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
Constraints:
Length: 1 - 500
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
ByteBuffer data
Constraints:
Length: 0 - 1048576
String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
String partitionKey
Constraints:
Length: 1 - 256
Integer failedRecordCount
PutRecords
request.
Constraints:
Range: 1 - 100000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
SequenceNumber
and ShardId
in the result. A
record that fails to be added to your Amazon Kinesis stream includes
ErrorCode
and ErrorMessage
in the result.
Constraints:
Length: 1 - 500
String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String errorCode
ErrorCodes
can be either
ProvisionedThroughputExceededException
or
InternalFailure
.String errorMessage
ErrorCode
value of
ProvisionedThroughputExceededException
has an error
message that includes the account ID, stream name, and shard ID. An
ErrorCode
value of InternalFailure
has the
error message "Internal Service Failure"
.String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
Date approximateArrivalTimestamp
ByteBuffer data
Constraints:
Length: 0 - 1048576
String partitionKey
Constraints:
Length: 1 - 256
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
Constraints:
Length: 1 - 10
String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
String endingSequenceNumber
null
.
Constraints:
Pattern: 0|([1-9]\d{0,128})
String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String parentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String adjacentParentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
HashKeyRange hashKeyRange
SequenceNumberRange sequenceNumberRange
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String shardToSplit
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String newStartingHashKey
NewStartingHashKey
must be in the range of hash keys
being mapped into the shard. The NewStartingHashKey
hash
key value and all higher hash key values in hash key range are
distributed to one of the child shards. All the lower hash key values
in the range are distributed to the other child shard.
Constraints:
Pattern: 0|([1-9]\d{0,38})
String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamARN
String streamStatus
The stream status is one of the following states:
CREATING
- The
stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.DELETING
- The stream is being deleted. The specified
stream is in the DELETING
state until Amazon Kinesis
completes the deletion.ACTIVE
- The stream
exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an
ACTIVE
stream.UPDATING
- Shards in
the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
com.amazonaws.internal.ListWithAutoConstructFlag<T> shards
Boolean hasMoreShards
true
, more shards in the stream are available
to describe.Integer retentionPeriodHours
Constraints:
Range: 24 - 168
String key
Constraints:
Length: 1 - 128
String value
Constraints:
Length: 0 - 256
Integer sizeInMBs
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher.
Integer intervalInSeconds
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
String dataTableName
The name of the target table. The table must already exist in the database.
String dataTableColumns
A comma-separated list of column names.
String copyOptions
Optional parameters to use with the Amazon Redshift COPY
command. For more information, see the "Optional Parameters" section of
Amazon
Redshift COPY command. Some possible examples that would apply to
Amazon Kinesis Firehose are as follows.
delimiter '\t' lzop;
- fields are delimited with "\t" (TAB
character) and compressed using lzop.
delimiter '|
- fields are delimited with "|" (this is the
default delimiter).
delimiter '|' escape
- the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after
every column in the table.
JSON 's3://mybucket/jsonpaths.txt'
- data is in JSON format,
and the path specified is the format of the data.
For more examples, see and Amazon Redshift COPY command exmaples.
String deliveryStreamName
The name of the delivery stream.
S3DestinationConfiguration s3DestinationConfiguration
The destination in Amazon S3. This value must be specified if
RedshiftDestinationConfiguration
is specified (see
restrictions listed above).
RedshiftDestinationConfiguration redshiftDestinationConfiguration
The destination in Amazon Redshift. This value cannot be specified if Amazon S3 is the desired destination (see restrictions listed above).
String deliveryStreamARN
The ARN of the delivery stream.
String deliveryStreamName
The name of the delivery stream.
String deliveryStreamName
The name of the delivery stream.
String deliveryStreamARN
The Amazon Resource Name (ARN) of the delivery stream.
String deliveryStreamStatus
The status of the delivery stream.
String versionId
Used when calling the UpdateDestination operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
Date createTimestamp
The date and time that the delivery stream was created.
Date lastUpdateTimestamp
The date and time that the delivery stream was last updated.
List<E> destinations
The destinations.
Boolean hasMoreDestinations
Indicates whether there are more destinations available to list.
String deliveryStreamName
The name of the delivery stream.
Integer limit
The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.
String exclusiveStartDestinationId
Specifies the destination ID to start returning the destination information. Currently Amazon Kinesis Firehose supports one destination per delivery stream.
DeliveryStreamDescription deliveryStreamDescription
Information about the delivery stream.
String destinationId
The ID of the destination.
S3DestinationDescription s3DestinationDescription
The Amazon S3 destination.
RedshiftDestinationDescription redshiftDestinationDescription
The destination in Amazon Redshift.
String noEncryptionConfig
Specifically override existing encryption information to ensure no encryption is used.
KMSEncryptionConfig kMSEncryptionConfig
The encryption key.
String aWSKMSKeyARN
The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
String recordId
The ID of the record.
ByteBuffer data
The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY
command.
String username
The name of the user.
String password
The user password.
S3DestinationConfiguration s3Configuration
The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
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.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY
command.
String username
The name of the user.
S3DestinationDescription s3DestinationDescription
The Amazon S3 destination.
String roleARN
The ARN of the AWS credentials.
String clusterJDBCURL
The database connection string.
CopyCommand copyCommand
The COPY
command.
String username
The name of the user.
String password
The user password.
S3DestinationUpdate s3Update
The Amazon S3 destination.
The compression formats SNAPPY
or ZIP
cannot be
specified in RedshiftDestinationUpdate.S3Update
because the
Amazon Redshift COPY
operation that reads from the S3 bucket
doesn't support these compression formats.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints
object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be
specified for Amazon Redshift destinations because they are not supported
by the Amazon Redshift COPY
operation that reads from the S3
bucket.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints
object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
NOCOMPRESSION
.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String roleARN
The ARN of the AWS credentials.
String bucketARN
The ARN of the S3 bucket.
String prefix
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the guide-fh-dev.
BufferingHints bufferingHints
The buffering option. If no value is specified,
BufferingHints
object default values are used.
String compressionFormat
The compression format. If no value is specified, the default is
NOCOMPRESSION
.
The compression formats SNAPPY
or ZIP
cannot be
specified for Amazon Redshift destinations because they are not supported
by the Amazon Redshift COPY
operation that reads from the S3
bucket.
EncryptionConfiguration encryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
String deliveryStreamName
The name of the delivery stream.
String currentDeliveryStreamVersionId
Obtain this value from the VersionId
result of the
DeliveryStreamDescription operation. This value is required, and
helps the service to perform conditional operations. For example, if
there is a interleaving update and this value is null, then the update
destination fails. After the update is successful, the
VersionId
value is updated. The service then performs a
merge of the old configuration with the new configuration.
String destinationId
The ID of the destination.
S3DestinationUpdate s3DestinationUpdate
RedshiftDestinationUpdate redshiftDestinationUpdate
Copyright © 2015. All rights reserved.