<a id="cli-aws-kinesis-receive-queue-records"></a>

# receive-queue-records

## Description

Receives up to 10 records from the specified queue. Each record is returned with a receipt handle, which is the identifier you use to acknowledge the record or change its visibility.

A record returned by `ReceiveQueueRecords` becomes in flight: it is not visible to any consumer instance for the duration of its visibility timeout, so subsequent receive requests do not return it while your queue consumer processes it. Acknowledge the record with  AcknowledgeQueueRecords when you finish processing it. A record that is not acknowledged before its visibility timeout expires becomes visible in the queue again and can be received by any consumer instance.

Use `WaitTimeSeconds` to control how long the call waits for a record to become visible before returning. If a record becomes visible sooner, the call returns sooner. If the wait time expires and no records are visible, the call returns an empty list of records.

Records are not necessarily received in the order they were written to the data stream.

A queue delivers records while it is in the `ACTIVE` state.

On rare occasions, a queue can deliver a record more than once. Design your queue consumer to be idempotent, so that processing the same record more than once is safe.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ReceiveQueueRecords)

## Synopsis

```
  receive-queue-records
--queue-arn <value>
[--limit <value>]
[--wait-time-seconds <value>]
[--visibility-timeout-seconds <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--queue-arn` (string) [required]

> The ARN of the queue to receive records from.

> Constraints:

> * min: `1`
> * max: `2048`
> * pattern: `arn:aws.*:kinesis:.*:\d{12}:queue/\S+`

`--limit` (integer)

> The maximum number of records to return. The queue never returns more records than this value, and might return fewer. The default is 10.

> Constraints:

> * min: `1`
> * max: `10`

`--wait-time-seconds` (integer)

> The duration, in seconds, that the call waits for a record to become visible before returning. The default is 9.

> Constraints:

> * min: `1`
> * max: `20`

`--visibility-timeout-seconds` (integer)

> The duration, in seconds, that the records returned by this request are in flight and not visible to any consumer instance. If you do not specify this value, the queue’s visibility timeout is used.

> Constraints:

> * min: `0`
> * max: `43200`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

QueueRecords -> (list)

> The records received from the queue. This list is empty when no records are visible.

> (structure)

> > A data stream record, as delivered through a queue.

> > ReceiptHandle -> (string) [required]

> > > The identifier you use to acknowledge this record, change its visibility, or restore it after it becomes a dead-letter record. A new receipt handle is issued each time the record is received.

> > > Constraints:

> > > * min: `1`
> > > * max: `1024`

> > RecordId -> (string) [required]

> > > The unique identifier of the record. This value stays the same across every delivery of the record, and it is the same in every queue on the stream that delivers the record. To identify a single delivery, use `ReceiptHandle` instead.

> > > Constraints:

> > > * min: `1`
> > > * max: `64`
> > > * pattern: `^[a-z0-9]+$`

> > PartitionKey -> (string)

> > > The partition key the record was written to the data stream with.

> > > Constraints:

> > > * min: `1`
> > > * max: `256`

> > Data -> (blob) [required]

> > > The data blob of the record. Amazon Kinesis Data Streams does not inspect, interpret, or change the data.

> > > Constraints:

> > > * min: `0`
> > > * max: `10485760`

> > ApproximateArrivalTimestamp -> (timestamp) [required]

> > > The approximate time the record arrived in the data stream. The difference between this value and the current time is how long the record took to reach your queue consumer.

> > FirstReceiveTimestamp -> (timestamp) [required]

> > > The approximate time the record was first received from the queue.

> > ReceiveCount -> (integer) [required]

> > > The number of times this record has been received without being acknowledged.

> > > Constraints:

> > > * min: `0`
