NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class KinesisClient

Client to interact with Amazon Kinesis

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\Kinesis\KinesisClient

Namespace: Aws\Kinesis
Link: User guide
Link: API docs
Located at Aws/Kinesis/KinesisClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new Amazon Kinesis client using an array of configuration options.

- `public` `__call ( string $method, array $args )`

  Magic method used to retrieve a command

- `public` `addTagsToStream ( array $args = array() )`

  Executes the AddTagsToStream operation.

- `public` `createStream ( array $args = array() )`

  Executes the CreateStream operation.

- `public` `decreaseStreamRetentionPeriod ( array $args = array() )`

  Executes the DecreaseStreamRetentionPeriod operation.

- `public` `deleteStream ( array $args = array() )`

  Executes the DeleteStream operation.

- `public` `describeStream ( array $args = array() )`

  Executes the DescribeStream operation.

- `public` `getRecords ( array $args = array() )`

  Executes the GetRecords operation.

- `public` `getShardIterator ( array $args = array() )`

  Executes the GetShardIterator operation.

- `public` `increaseStreamRetentionPeriod ( array $args = array() )`

  Executes the IncreaseStreamRetentionPeriod operation.

- `public` `listStreams ( array $args = array() )`

  Executes the ListStreams operation.

- `public` `listTagsForStream ( array $args = array() )`

  Executes the ListTagsForStream operation.

- `public` `mergeShards ( array $args = array() )`

  Executes the MergeShards operation.

- `public` `putRecord ( array $args = array() )`

  Executes the PutRecord operation.

- `public` `putRecords ( array $args = array() )`

  Executes the PutRecords operation.

- `public` `removeTagsFromStream ( array $args = array() )`

  Executes the RemoveTagsFromStream operation.

- `public` `splitShard ( array $args = array() )`

  Executes the SplitShard operation.

- `public` `getDescribeStreamIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeStream operation

- `public` `getListStreamsIterator ( array $args = array() )`

  The input array uses the parameters of the ListStreams operation

## Methods detail

# `public static `Aws\Kinesis\KinesisClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new Amazon Kinesis client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\Kinesis\KinesisClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public mixed`
`__call( string $method, array $args )`

Magic method used to retrieve a command

#### Parameters

$method
  `string`
  $method Name of the command object to instantiate
$args
  `array`
  $args Arguments to pass to the command

#### Returns

`mixed`
Returns the result of the command

#### Throws

``BadMethodCallException``
when a command is not found

#### Overrides

`Aws\Common\Client\AbstractClient::__call`
# `public `Guzzle\Service\Resource\Model``
`addTagsToStream( array $args = array() )`

Executes the AddTagsToStream operation.

Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

#### Examples

- Basic formatting example

      $result = $client->addTagsToStream(array(
          // StreamName is required
          'StreamName' => 'string',
          // Tags is required
          'Tags' => array(
              // Associative array of custom 'TagKey' key names
              'TagKey' => 'string',
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream.

  - Tags => (associative-array<string>)

    Associative array of <TagKey> keys mapping to (string) values. Each array key should be changed to an appropriate <TagKey>.

    The set of key-value pairs to use to create the tags.

    - <TagKey> => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`createStream( array $args = array() )`

Executes the CreateStream operation.

Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets the stream status to CREATING . After the stream is created, Amazon Kinesis sets the stream status to ACTIVE . You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:

- Have more than five streams in the CREATING state at any point in time.
- Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Limits. If you need to increase this limit, contact AWS Support.

You can use DescribeStream to check the stream status, which is returned in StreamStatus .

CreateStream has a limit of 5 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->createStream(array(
          // StreamName is required
          'StreamName' => 'string',
          // ShardCount is required
          'ShardCount' => integer,
      ));

- Execute the CreateStream operation

      $client->createStream(array(
          'StreamName' => 'php-test-stream',
          'ShardCount' => 1,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account, but in two different regions, can have the same name.

  - ShardCount => (int)

    The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

    DefaultShardLimit;

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`decreaseStreamRetentionPeriod( array $args = array() )`

Executes the DecreaseStreamRetentionPeriod operation.

Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

#### Examples

- Basic formatting example

      $result = $client->decreaseStreamRetentionPeriod(array(
          // StreamName is required
          'StreamName' => 'string',
          // RetentionPeriodHours is required
          'RetentionPeriodHours' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream to modify.

  - RetentionPeriodHours => (int)

    The new retention period of the stream, in hours. Must be less than the current retention period.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteStream( array $args = array() )`

Executes the DeleteStream operation.

Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException .

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus .

DeleteStream has a limit of 5 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->deleteStream(array(
          // StreamName is required
          'StreamName' => 'string',
      ));

- Execute the DeleteStream operation

      $client->deleteStream(array(
          'StreamName' => 'php-test-stream',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`describeStream( array $args = array() )`

Executes the DescribeStream operation.

Describes the specified stream.

The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.

You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream . You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.

DescribeStream is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream .

DescribeStream has a limit of 10 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->describeStream(array(
          // StreamName is required
          'StreamName' => 'string',
          'Limit' => integer,
          'ExclusiveStartShardId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream to describe.

  - Limit => (int)

    The maximum number of shards to return.

  - ExclusiveStartShardId => (string)

    The shard ID of the shard to start with.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- StreamDescription => (associative-array)

  The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.

  - StreamName => (string)

    The name of the stream being described.

  - StreamARN => (string)

    The Amazon Resource Name (ARN) for the stream being described.

  - StreamStatus => (string)

    The current status of the stream being described.

    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.
  - Shards => (array<associative-array>)

    The shards that comprise the stream.

    - (associative-array)

      A uniquely identified group of data records in an Amazon Kinesis stream.

      - ShardId => (string)

        The unique identifier of the shard within the Amazon Kinesis stream.

      - ParentShardId => (string)

        The shard Id of the shard's parent.

      - AdjacentParentShardId => (string)

        The shard Id of the shard adjacent to the shard's parent.

      - HashKeyRange => (associative-array)

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

        - StartingHashKey => (string)

          The starting hash key of the hash key range.

        - EndingHashKey => (string)

          The ending hash key of the hash key range.

      - SequenceNumberRange => (associative-array)

        The range of possible sequence numbers for the shard.

        - StartingSequenceNumber => (string)

          The starting sequence number for the range.

        - EndingSequenceNumber => (string)

          The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

  - HasMoreShards => (bool)

    If set to true, more shards in the stream are available to describe.

  - RetentionPeriodHours => (int)

    The current retention period, in hours.

# `public `Guzzle\Service\Resource\Model``
`getRecords( array $args = array() )`

Executes the GetRecords operation.

Gets data records from a shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator . Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. Note that if the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator . You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

The size of the data returned by GetRecords will vary depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException . If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException . Note that GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics (see Monitoring Amazon Kinesis in the Amazon Kinesis Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp , that is set when an Amazon Kinesis stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, which is different than a client-side timestamp, where the timestamp is set when a data producer creates or sends the record to a stream. The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.

#### Examples

- Basic formatting example

      $result = $client->getRecords(array(
          // ShardIterator is required
          'ShardIterator' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ShardIterator => (string)

    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

  - Limit => (int)

    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Records => (array<associative-array>)

  The data records retrieved from the shard.

  - (associative-array)

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

    - SequenceNumber => (string)

      The unique identifier of the record in the stream.

    - ApproximateArrivalTimestamp => (string)

      The approximate time that the record was inserted into the stream.

    - Data => (string)

      The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

    - PartitionKey => (string)

      Identifies which shard in the stream the data record is assigned to.

- NextShardIterator => (string)

  The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

- MillisBehindLatest => (int)

  The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

# `public `Guzzle\Service\Resource\Model``
`getShardIterator( array $args = array() )`

Executes the GetShardIterator operation.

Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester.

A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. You can specify the shard iterator type TRIM_HORIZON in the request to cause ShardIterator to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type LATEST , so that you always read the most recent data in the shard.

When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and then use the shard iterator returned by the GetRecords request in NextShardIterator for subsequent reads. A new shard iterator is returned by every GetRecords request in NextShardIterator , which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException . For more information about throughput limits, see GetRecords.

If the shard is closed, the iterator can't return more data, and GetShardIterator returns null for its ShardIterator . A shard can be closed using SplitShard or MergeShards.

GetShardIterator has a limit of 5 transactions per second per account per open shard.

#### Examples

- Basic formatting example

      $result = $client->getShardIterator(array(
          // StreamName is required
          'StreamName' => 'string',
          // ShardId is required
          'ShardId' => 'string',
          // ShardIteratorType is required
          'ShardIteratorType' => 'string',
          'StartingSequenceNumber' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream.

  - ShardId => (string)

    The shard ID of the shard to get the iterator for.

  - ShardIteratorType => (string: AT_SEQUENCE_NUMBER | AFTER_SEQUENCE_NUMBER | TRIM_HORIZON | LATEST )

    Determines how the shard iterator is used to start reading data records from the shard.

    The following are the valid shard iterator types:

    - AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
    - AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.
    - TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
    - LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
  - StartingSequenceNumber => (string)

    The sequence number of the data record in the shard from which to start reading from.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ShardIterator => (string)

  The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

# `public `Guzzle\Service\Resource\Model``
`increaseStreamRetentionPeriod( array $args = array() )`

Executes the IncreaseStreamRetentionPeriod operation.

Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days).

Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.

#### Examples

- Basic formatting example

      $result = $client->increaseStreamRetentionPeriod(array(
          // StreamName is required
          'StreamName' => 'string',
          // RetentionPeriodHours is required
          'RetentionPeriodHours' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream to modify.

  - RetentionPeriodHours => (int)

    The new retention period of the stream, in hours. Must be more than the current retention period.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`listStreams( array $args = array() )`

Executes the ListStreams operation.

Lists your streams.

The number of streams may be too large to return from a single call to ListStreams . You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams . The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of 5 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->listStreams(array(
          'Limit' => integer,
          'ExclusiveStartStreamName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Limit => (int)

    The maximum number of streams to list.

  - ExclusiveStartStreamName => (string)

    The name of the stream to start the list with.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- StreamNames => (array<string>)

  The names of the streams that are associated with the AWS account making the ListStreams request.

- HasMoreStreams => (bool)

  If set to true, there are more streams available to list.

# `public `Guzzle\Service\Resource\Model``
`listTagsForStream( array $args = array() )`

Executes the ListTagsForStream operation.

Lists the tags for the specified Amazon Kinesis stream.

#### Examples

- Basic formatting example

      $result = $client->listTagsForStream(array(
          // StreamName is required
          'StreamName' => 'string',
          'ExclusiveStartTagKey' => 'string',
          'Limit' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream.

  - ExclusiveStartTagKey => (string)

    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

  - Limit => (int)

    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Tags => (array<associative-array>)

  A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

  - (associative-array)

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

    - Key => (string)

      A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

    - Value => (string)

      An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

- HasMoreTags => (bool)

  If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

# `public `Guzzle\Service\Resource\Model``
`mergeShards( array $args = array() )`

Executes the MergeShards operation.

Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards . If a stream is in the CREATING , UPDATING , or DELETING state, MergeShards returns a ResourceInUseException . If the specified stream does not exist, MergeShards returns a ResourceNotFoundException .

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus .

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING . After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE . Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException .

MergeShards has limit of 5 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->mergeShards(array(
          // StreamName is required
          'StreamName' => 'string',
          // ShardToMerge is required
          'ShardToMerge' => 'string',
          // AdjacentShardToMerge is required
          'AdjacentShardToMerge' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream for the merge.

  - ShardToMerge => (string)

    The shard ID of the shard to combine with the adjacent shard for the merge.

  - AdjacentShardToMerge => (string)

    The shard ID of the adjacent shard for the merge.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`putRecord( array $args = array() )`

Executes the PutRecord operation.

Writes a single data record from a producer into an Amazon Kinesis stream. Call PutRecord to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException .

By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.

#### Examples

- Basic formatting example

      $result = $client->putRecord(array(
          // StreamName is required
          'StreamName' => 'string',
          // Data is required
          'Data' => 'string',
          // PartitionKey is required
          'PartitionKey' => 'string',
          'ExplicitHashKey' => 'string',
          'SequenceNumberForOrdering' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream to put the data record into.

  - Data => (string)

    The supplied string value will be automatically base64 encoded by the SDK. Base64 encoding this value before passing it into an operation will double-encode the data.

    The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

  - PartitionKey => (string)

    Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.

  - ExplicitHashKey => (string)

    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

  - SequenceNumberForOrdering => (string)

    Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the 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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ShardId => (string)

  The shard ID of the shard where the data record was placed.

- SequenceNumber => (string)

  The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

# `public `Guzzle\Service\Resource\Model``
`putRecords( array $args = array() )`

Executes the PutRecords operation.

Writes multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data from a data producer into the Amazon Kinesis stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records , with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey , which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide.

The PutRecords response includes an array of response Records . Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure . ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide.

By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.

#### Examples

- Basic formatting example

      $result = $client->putRecords(array(
          // Records is required
          'Records' => array(
              array(
                  // Data is required
                  'Data' => 'string',
                  'ExplicitHashKey' => 'string',
                  // PartitionKey is required
                  'PartitionKey' => 'string',
              ),
              // ... repeated
          ),
          // StreamName is required
          'StreamName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Records => (array<associative-array>)

    The records associated with the request.

    - (associative-array)

      Represents the output for PutRecords.

      - Data => (string)

        The supplied string value will be automatically base64 encoded by the SDK. Base64 encoding this value before passing it into an operation will double-encode the data.

        The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

      - ExplicitHashKey => (string)

        The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

      - PartitionKey => (string)

        Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

  - StreamName => (string)

    The stream name associated with the request.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- FailedRecordCount => (int)

  The number of unsuccessfully processed records in a PutRecords request.

- Records => (array<associative-array>)

  An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to your Amazon Kinesis stream includes 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.

  - (associative-array)

    Represents the result of an individual record from a PutRecords request. A record that is successfully added to your Amazon Kinesis stream includes 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.

    - SequenceNumber => (string)

      The sequence number for an individual record result.

    - ShardId => (string)

      The shard ID for an individual record result.

    - ErrorCode => (string)

      The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

    - ErrorMessage => (string)

      The error message for an individual record result. An 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".

# `public `Guzzle\Service\Resource\Model``
`removeTagsFromStream( array $args = array() )`

Executes the RemoveTagsFromStream operation.

Deletes tags from the specified Amazon Kinesis stream.

If you specify a tag that does not exist, it is ignored.

#### Examples

- Basic formatting example

      $result = $client->removeTagsFromStream(array(
          // StreamName is required
          'StreamName' => 'string',
          // TagKeys is required
          'TagKeys' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream.

  - TagKeys => (array<string>)

    A list of tag keys. Each corresponding tag is removed from the stream.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`splitShard( array $args = array() )`

Executes the SplitShard operation.

Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see Split a Shard in the Amazon Kinesis Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING . After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE . Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus . If the stream is in the ACTIVE state, you can call SplitShard . If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException .

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException . If you try to create more shards than are authorized for your account, you receive a LimitExceededException .

For the default shard limit for an AWS account, see Amazon Kinesis Limits. If you need to increase this limit, contact AWS Support.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you receive a LimitExceededException .

SplitShard has limit of 5 transactions per second per account.

#### Examples

- Basic formatting example

      $result = $client->splitShard(array(
          // StreamName is required
          'StreamName' => 'string',
          // ShardToSplit is required
          'ShardToSplit' => 'string',
          // NewStartingHashKey is required
          'NewStartingHashKey' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - StreamName => (string)

    The name of the stream for the shard split.

  - ShardToSplit => (string)

    The shard ID of the shard to split.

  - NewStartingHashKey => (string)

    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for 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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeStreamIterator( array $args = array() )`

The input array uses the parameters of the DescribeStream operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListStreamsIterator( array $args = array() )`

The input array uses the parameters of the ListStreams operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2013-12-02'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`