BatchPutMessage

$result = $client->batchPutMessage([/* ... */]);
$promise = $client->batchPutMessageAsync([/* ... */]);

Sends messages to a channel.

Parameter Syntax

$result = $client->batchPutMessage([
    'channelName' => '<string>', // REQUIRED
    'messages' => [ // REQUIRED
        [
            'messageId' => '<string>', // REQUIRED
            'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'batchPutMessageErrorEntries' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'messageId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

A resource with the specified name could not be found.

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

CancelPipelineReprocessing

$result = $client->cancelPipelineReprocessing([/* ... */]);
$promise = $client->cancelPipelineReprocessingAsync([/* ... */]);

Cancels the reprocessing of data through the pipeline.

Parameter Syntax

$result = $client->cancelPipelineReprocessing([
    'pipelineName' => '<string>', // REQUIRED
    'reprocessingId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A resource with the specified name could not be found.

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

Parameter Syntax

$result = $client->createChannel([
    'channelName' => '<string>', // REQUIRED
    'channelStorage' => [
        'customerManagedS3' => [
            'bucket' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'serviceManagedS3' => [
        ],
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'channelArn' => '<string>',
    'channelName' => '<string>',
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceAlreadyExistsException:

A resource with the same name already exists.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.

Parameter Syntax

$result = $client->createDataset([
    'actions' => [ // REQUIRED
        [
            'actionName' => '<string>',
            'containerAction' => [
                'executionRoleArn' => '<string>', // REQUIRED
                'image' => '<string>', // REQUIRED
                'resourceConfiguration' => [ // REQUIRED
                    'computeType' => 'ACU_1|ACU_2', // REQUIRED
                    'volumeSizeInGB' => <integer>, // REQUIRED
                ],
                'variables' => [
                    [
                        'datasetContentVersionValue' => [
                            'datasetName' => '<string>', // REQUIRED
                        ],
                        'doubleValue' => <float>,
                        'name' => '<string>', // REQUIRED
                        'outputFileUriValue' => [
                            'fileName' => '<string>', // REQUIRED
                        ],
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
            ],
            'queryAction' => [
                'filters' => [
                    [
                        'deltaTime' => [
                            'offsetSeconds' => <integer>, // REQUIRED
                            'timeExpression' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'sqlQuery' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'contentDeliveryRules' => [
        [
            'destination' => [ // REQUIRED
                'iotEventsDestinationConfiguration' => [
                    'inputName' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
                's3DestinationConfiguration' => [
                    'bucket' => '<string>', // REQUIRED
                    'glueConfiguration' => [
                        'databaseName' => '<string>', // REQUIRED
                        'tableName' => '<string>', // REQUIRED
                    ],
                    'key' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
            ],
            'entryName' => '<string>',
        ],
        // ...
    ],
    'datasetName' => '<string>', // REQUIRED
    'lateDataRules' => [
        [
            'ruleConfiguration' => [ // REQUIRED
                'deltaTimeSessionWindowConfiguration' => [
                    'timeoutInMinutes' => <integer>, // REQUIRED
                ],
            ],
            'ruleName' => '<string>',
        ],
        // ...
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'triggers' => [
        [
            'dataset' => [
                'name' => '<string>', // REQUIRED
            ],
            'schedule' => [
                'expression' => '<string>',
            ],
        ],
        // ...
    ],
    'versioningConfiguration' => [
        'maxVersions' => <integer>,
        'unlimited' => true || false,
    ],
]);

Parameter Details

Result Syntax

[
    'datasetArn' => '<string>',
    'datasetName' => '<string>',
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceAlreadyExistsException:

A resource with the same name already exists.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

CreateDatasetContent

$result = $client->createDatasetContent([/* ... */]);
$promise = $client->createDatasetContentAsync([/* ... */]);

Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).

Parameter Syntax

$result = $client->createDatasetContent([
    'datasetName' => '<string>', // REQUIRED
    'versionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'versionId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

CreateDatastore

$result = $client->createDatastore([/* ... */]);
$promise = $client->createDatastoreAsync([/* ... */]);

Creates a data store, which is a repository for messages.

Parameter Syntax

$result = $client->createDatastore([
    'datastoreName' => '<string>', // REQUIRED
    'datastorePartitions' => [
        'partitions' => [
            [
                'attributePartition' => [
                    'attributeName' => '<string>', // REQUIRED
                ],
                'timestampPartition' => [
                    'attributeName' => '<string>', // REQUIRED
                    'timestampFormat' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'datastoreStorage' => [
        'customerManagedS3' => [
            'bucket' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'iotSiteWiseMultiLayerStorage' => [
            'customerManagedS3Storage' => [ // REQUIRED
                'bucket' => '<string>', // REQUIRED
                'keyPrefix' => '<string>',
            ],
        ],
        'serviceManagedS3' => [
        ],
    ],
    'fileFormatConfiguration' => [
        'jsonConfiguration' => [
        ],
        'parquetConfiguration' => [
            'schemaDefinition' => [
                'columns' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'datastoreArn' => '<string>',
    'datastoreName' => '<string>',
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceAlreadyExistsException:

A resource with the same name already exists.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

CreatePipeline

$result = $client->createPipeline([/* ... */]);
$promise = $client->createPipelineAsync([/* ... */]);

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Parameter Syntax

$result = $client->createPipeline([
    'pipelineActivities' => [ // REQUIRED
        [
            'addAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'channel' => [
                'channelName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'datastore' => [
                'datastoreName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
            ],
            'deviceRegistryEnrich' => [
                'attribute' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'thingName' => '<string>', // REQUIRED
            ],
            'deviceShadowEnrich' => [
                'attribute' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'thingName' => '<string>', // REQUIRED
            ],
            'filter' => [
                'filter' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'lambda' => [
                'batchSize' => <integer>, // REQUIRED
                'lambdaName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'math' => [
                'attribute' => '<string>', // REQUIRED
                'math' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'removeAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'selectAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
        ],
        // ...
    ],
    'pipelineName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'pipelineArn' => '<string>',
    'pipelineName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceAlreadyExistsException:

A resource with the same name already exists.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Deletes the specified channel.

Parameter Syntax

$result = $client->deleteChannel([
    'channelName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

Deletes the specified dataset.

You do not have to delete the content of the dataset before you perform this operation.

Parameter Syntax

$result = $client->deleteDataset([
    'datasetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DeleteDatasetContent

$result = $client->deleteDatasetContent([/* ... */]);
$promise = $client->deleteDatasetContentAsync([/* ... */]);

Deletes the content of the specified dataset.

Parameter Syntax

$result = $client->deleteDatasetContent([
    'datasetName' => '<string>', // REQUIRED
    'versionId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DeleteDatastore

$result = $client->deleteDatastore([/* ... */]);
$promise = $client->deleteDatastoreAsync([/* ... */]);

Deletes the specified data store.

Parameter Syntax

$result = $client->deleteDatastore([
    'datastoreName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DeletePipeline

$result = $client->deletePipeline([/* ... */]);
$promise = $client->deletePipelineAsync([/* ... */]);

Deletes the specified pipeline.

Parameter Syntax

$result = $client->deletePipeline([
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DescribeChannel

$result = $client->describeChannel([/* ... */]);
$promise = $client->describeChannelAsync([/* ... */]);

Retrieves information about a channel.

Parameter Syntax

$result = $client->describeChannel([
    'channelName' => '<string>', // REQUIRED
    'includeStatistics' => true || false,
]);

Parameter Details

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'lastMessageArrivalTime' => <DateTime>,
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'retentionPeriod' => [
            'numberOfDays' => <integer>,
            'unlimited' => true || false,
        ],
        'status' => 'CREATING|ACTIVE|DELETING',
        'storage' => [
            'customerManagedS3' => [
                'bucket' => '<string>',
                'keyPrefix' => '<string>',
                'roleArn' => '<string>',
            ],
            'serviceManagedS3' => [
            ],
        ],
    ],
    'statistics' => [
        'size' => [
            'estimatedOn' => <DateTime>,
            'estimatedSizeInBytes' => <float>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

Retrieves information about a dataset.

Parameter Syntax

$result = $client->describeDataset([
    'datasetName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dataset' => [
        'actions' => [
            [
                'actionName' => '<string>',
                'containerAction' => [
                    'executionRoleArn' => '<string>',
                    'image' => '<string>',
                    'resourceConfiguration' => [
                        'computeType' => 'ACU_1|ACU_2',
                        'volumeSizeInGB' => <integer>,
                    ],
                    'variables' => [
                        [
                            'datasetContentVersionValue' => [
                                'datasetName' => '<string>',
                            ],
                            'doubleValue' => <float>,
                            'name' => '<string>',
                            'outputFileUriValue' => [
                                'fileName' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'queryAction' => [
                    'filters' => [
                        [
                            'deltaTime' => [
                                'offsetSeconds' => <integer>,
                                'timeExpression' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'sqlQuery' => '<string>',
                ],
            ],
            // ...
        ],
        'arn' => '<string>',
        'contentDeliveryRules' => [
            [
                'destination' => [
                    'iotEventsDestinationConfiguration' => [
                        'inputName' => '<string>',
                        'roleArn' => '<string>',
                    ],
                    's3DestinationConfiguration' => [
                        'bucket' => '<string>',
                        'glueConfiguration' => [
                            'databaseName' => '<string>',
                            'tableName' => '<string>',
                        ],
                        'key' => '<string>',
                        'roleArn' => '<string>',
                    ],
                ],
                'entryName' => '<string>',
            ],
            // ...
        ],
        'creationTime' => <DateTime>,
        'lastUpdateTime' => <DateTime>,
        'lateDataRules' => [
            [
                'ruleConfiguration' => [
                    'deltaTimeSessionWindowConfiguration' => [
                        'timeoutInMinutes' => <integer>,
                    ],
                ],
                'ruleName' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>',
        'retentionPeriod' => [
            'numberOfDays' => <integer>,
            'unlimited' => true || false,
        ],
        'status' => 'CREATING|ACTIVE|DELETING',
        'triggers' => [
            [
                'dataset' => [
                    'name' => '<string>',
                ],
                'schedule' => [
                    'expression' => '<string>',
                ],
            ],
            // ...
        ],
        'versioningConfiguration' => [
            'maxVersions' => <integer>,
            'unlimited' => true || false,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DescribeDatastore

$result = $client->describeDatastore([/* ... */]);
$promise = $client->describeDatastoreAsync([/* ... */]);

Retrieves information about a data store.

Parameter Syntax

$result = $client->describeDatastore([
    'datastoreName' => '<string>', // REQUIRED
    'includeStatistics' => true || false,
]);

Parameter Details

Result Syntax

[
    'datastore' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'datastorePartitions' => [
            'partitions' => [
                [
                    'attributePartition' => [
                        'attributeName' => '<string>',
                    ],
                    'timestampPartition' => [
                        'attributeName' => '<string>',
                        'timestampFormat' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        'fileFormatConfiguration' => [
            'jsonConfiguration' => [
            ],
            'parquetConfiguration' => [
                'schemaDefinition' => [
                    'columns' => [
                        [
                            'name' => '<string>',
                            'type' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'lastMessageArrivalTime' => <DateTime>,
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'retentionPeriod' => [
            'numberOfDays' => <integer>,
            'unlimited' => true || false,
        ],
        'status' => 'CREATING|ACTIVE|DELETING',
        'storage' => [
            'customerManagedS3' => [
                'bucket' => '<string>',
                'keyPrefix' => '<string>',
                'roleArn' => '<string>',
            ],
            'iotSiteWiseMultiLayerStorage' => [
                'customerManagedS3Storage' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                ],
            ],
            'serviceManagedS3' => [
            ],
        ],
    ],
    'statistics' => [
        'size' => [
            'estimatedOn' => <DateTime>,
            'estimatedSizeInBytes' => <float>,
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DescribeLoggingOptions

$result = $client->describeLoggingOptions([/* ... */]);
$promise = $client->describeLoggingOptionsAsync([/* ... */]);

Retrieves the current settings of the IoT Analytics logging options.

Parameter Syntax

$result = $client->describeLoggingOptions([
]);

Parameter Details

Result Syntax

[
    'loggingOptions' => [
        'enabled' => true || false,
        'level' => 'ERROR',
        'roleArn' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

DescribePipeline

$result = $client->describePipeline([/* ... */]);
$promise = $client->describePipelineAsync([/* ... */]);

Retrieves information about a pipeline.

Parameter Syntax

$result = $client->describePipeline([
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'pipeline' => [
        'activities' => [
            [
                'addAttributes' => [
                    'attributes' => ['<string>', ...],
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'channel' => [
                    'channelName' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'datastore' => [
                    'datastoreName' => '<string>',
                    'name' => '<string>',
                ],
                'deviceRegistryEnrich' => [
                    'attribute' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                    'roleArn' => '<string>',
                    'thingName' => '<string>',
                ],
                'deviceShadowEnrich' => [
                    'attribute' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                    'roleArn' => '<string>',
                    'thingName' => '<string>',
                ],
                'filter' => [
                    'filter' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'lambda' => [
                    'batchSize' => <integer>,
                    'lambdaName' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'math' => [
                    'attribute' => '<string>',
                    'math' => '<string>',
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'removeAttributes' => [
                    'attributes' => ['<string>', ...],
                    'name' => '<string>',
                    'next' => '<string>',
                ],
                'selectAttributes' => [
                    'attributes' => ['<string>', ...],
                    'name' => '<string>',
                    'next' => '<string>',
                ],
            ],
            // ...
        ],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'reprocessingSummaries' => [
            [
                'creationTime' => <DateTime>,
                'id' => '<string>',
                'status' => 'RUNNING|SUCCEEDED|CANCELLED|FAILED',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

GetDatasetContent

$result = $client->getDatasetContent([/* ... */]);
$promise = $client->getDatasetContentAsync([/* ... */]);

Retrieves the contents of a dataset as presigned URIs.

Parameter Syntax

$result = $client->getDatasetContent([
    'datasetName' => '<string>', // REQUIRED
    'versionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'entries' => [
        [
            'dataURI' => '<string>',
            'entryName' => '<string>',
        ],
        // ...
    ],
    'status' => [
        'reason' => '<string>',
        'state' => 'CREATING|SUCCEEDED|FAILED',
    ],
    'timestamp' => <DateTime>,
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Retrieves a list of channels.

Parameter Syntax

$result = $client->listChannels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'channelSummaries' => [
        [
            'channelName' => '<string>',
            'channelStorage' => [
                'customerManagedS3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'roleArn' => '<string>',
                ],
                'serviceManagedS3' => [
                ],
            ],
            'creationTime' => <DateTime>,
            'lastMessageArrivalTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'status' => 'CREATING|ACTIVE|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ListDatasetContents

$result = $client->listDatasetContents([/* ... */]);
$promise = $client->listDatasetContentsAsync([/* ... */]);

Lists information about dataset contents that have been created.

Parameter Syntax

$result = $client->listDatasetContents([
    'datasetName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scheduledBefore' => <integer || string || DateTime>,
    'scheduledOnOrAfter' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'datasetContentSummaries' => [
        [
            'completionTime' => <DateTime>,
            'creationTime' => <DateTime>,
            'scheduleTime' => <DateTime>,
            'status' => [
                'reason' => '<string>',
                'state' => 'CREATING|SUCCEEDED|FAILED',
            ],
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

A resource with the specified name could not be found.

ListDatasets

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

Retrieves information about datasets.

Parameter Syntax

$result = $client->listDatasets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'datasetSummaries' => [
        [
            'actions' => [
                [
                    'actionName' => '<string>',
                    'actionType' => 'QUERY|CONTAINER',
                ],
                // ...
            ],
            'creationTime' => <DateTime>,
            'datasetName' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'status' => 'CREATING|ACTIVE|DELETING',
            'triggers' => [
                [
                    'dataset' => [
                        'name' => '<string>',
                    ],
                    'schedule' => [
                        'expression' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ListDatastores

$result = $client->listDatastores([/* ... */]);
$promise = $client->listDatastoresAsync([/* ... */]);

Retrieves a list of data stores.

Parameter Syntax

$result = $client->listDatastores([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'datastoreSummaries' => [
        [
            'creationTime' => <DateTime>,
            'datastoreName' => '<string>',
            'datastorePartitions' => [
                'partitions' => [
                    [
                        'attributePartition' => [
                            'attributeName' => '<string>',
                        ],
                        'timestampPartition' => [
                            'attributeName' => '<string>',
                            'timestampFormat' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            'datastoreStorage' => [
                'customerManagedS3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'roleArn' => '<string>',
                ],
                'iotSiteWiseMultiLayerStorage' => [
                    'customerManagedS3Storage' => [
                        'bucket' => '<string>',
                        'keyPrefix' => '<string>',
                    ],
                ],
                'serviceManagedS3' => [
                ],
            ],
            'fileFormatType' => 'JSON|PARQUET',
            'lastMessageArrivalTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'status' => 'CREATING|ACTIVE|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ListPipelines

$result = $client->listPipelines([/* ... */]);
$promise = $client->listPipelinesAsync([/* ... */]);

Retrieves a list of pipelines.

Parameter Syntax

$result = $client->listPipelines([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'pipelineSummaries' => [
        [
            'creationTime' => <DateTime>,
            'lastUpdateTime' => <DateTime>,
            'pipelineName' => '<string>',
            'reprocessingSummaries' => [
                [
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'status' => 'RUNNING|SUCCEEDED|CANCELLED|FAILED',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags (metadata) that you have assigned to the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

ResourceNotFoundException:

A resource with the specified name could not be found.

PutLoggingOptions

$result = $client->putLoggingOptions([/* ... */]);
$promise = $client->putLoggingOptionsAsync([/* ... */]);

Sets or updates the IoT Analytics logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

Parameter Syntax

$result = $client->putLoggingOptions([
    'loggingOptions' => [ // REQUIRED
        'enabled' => true || false, // REQUIRED
        'level' => 'ERROR', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

RunPipelineActivity

$result = $client->runPipelineActivity([/* ... */]);
$promise = $client->runPipelineActivityAsync([/* ... */]);

Simulates the results of running a pipeline activity on a message payload.

Parameter Syntax

$result = $client->runPipelineActivity([
    'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...], // REQUIRED
    'pipelineActivity' => [ // REQUIRED
        'addAttributes' => [
            'attributes' => ['<string>', ...], // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'channel' => [
            'channelName' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'datastore' => [
            'datastoreName' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'deviceRegistryEnrich' => [
            'attribute' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
            'roleArn' => '<string>', // REQUIRED
            'thingName' => '<string>', // REQUIRED
        ],
        'deviceShadowEnrich' => [
            'attribute' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
            'roleArn' => '<string>', // REQUIRED
            'thingName' => '<string>', // REQUIRED
        ],
        'filter' => [
            'filter' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'lambda' => [
            'batchSize' => <integer>, // REQUIRED
            'lambdaName' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'math' => [
            'attribute' => '<string>', // REQUIRED
            'math' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'removeAttributes' => [
            'attributes' => ['<string>', ...], // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
        'selectAttributes' => [
            'attributes' => ['<string>', ...], // REQUIRED
            'name' => '<string>', // REQUIRED
            'next' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'logResult' => '<string>',
    'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

SampleChannelData

$result = $client->sampleChannelData([/* ... */]);
$promise = $client->sampleChannelDataAsync([/* ... */]);

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

Parameter Syntax

$result = $client->sampleChannelData([
    'channelName' => '<string>', // REQUIRED
    'endTime' => <integer || string || DateTime>,
    'maxMessages' => <integer>,
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'payloads' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

StartPipelineReprocessing

$result = $client->startPipelineReprocessing([/* ... */]);
$promise = $client->startPipelineReprocessingAsync([/* ... */]);

Starts the reprocessing of raw message data through the pipeline.

Parameter Syntax

$result = $client->startPipelineReprocessing([
    'channelMessages' => [
        's3Paths' => ['<string>', ...],
    ],
    'endTime' => <integer || string || DateTime>,
    'pipelineName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'reprocessingId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A resource with the specified name could not be found.

ResourceAlreadyExistsException:

A resource with the same name already exists.

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

ResourceNotFoundException:

A resource with the specified name could not be found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the given tags (metadata) from the resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.

ResourceNotFoundException:

A resource with the specified name could not be found.

UpdateChannel

$result = $client->updateChannel([/* ... */]);
$promise = $client->updateChannelAsync([/* ... */]);

Used to update the settings of a channel.

Parameter Syntax

$result = $client->updateChannel([
    'channelName' => '<string>', // REQUIRED
    'channelStorage' => [
        'customerManagedS3' => [
            'bucket' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'serviceManagedS3' => [
        ],
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

UpdateDataset

$result = $client->updateDataset([/* ... */]);
$promise = $client->updateDatasetAsync([/* ... */]);

Updates the settings of a dataset.

Parameter Syntax

$result = $client->updateDataset([
    'actions' => [ // REQUIRED
        [
            'actionName' => '<string>',
            'containerAction' => [
                'executionRoleArn' => '<string>', // REQUIRED
                'image' => '<string>', // REQUIRED
                'resourceConfiguration' => [ // REQUIRED
                    'computeType' => 'ACU_1|ACU_2', // REQUIRED
                    'volumeSizeInGB' => <integer>, // REQUIRED
                ],
                'variables' => [
                    [
                        'datasetContentVersionValue' => [
                            'datasetName' => '<string>', // REQUIRED
                        ],
                        'doubleValue' => <float>,
                        'name' => '<string>', // REQUIRED
                        'outputFileUriValue' => [
                            'fileName' => '<string>', // REQUIRED
                        ],
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
            ],
            'queryAction' => [
                'filters' => [
                    [
                        'deltaTime' => [
                            'offsetSeconds' => <integer>, // REQUIRED
                            'timeExpression' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'sqlQuery' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'contentDeliveryRules' => [
        [
            'destination' => [ // REQUIRED
                'iotEventsDestinationConfiguration' => [
                    'inputName' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
                's3DestinationConfiguration' => [
                    'bucket' => '<string>', // REQUIRED
                    'glueConfiguration' => [
                        'databaseName' => '<string>', // REQUIRED
                        'tableName' => '<string>', // REQUIRED
                    ],
                    'key' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
            ],
            'entryName' => '<string>',
        ],
        // ...
    ],
    'datasetName' => '<string>', // REQUIRED
    'lateDataRules' => [
        [
            'ruleConfiguration' => [ // REQUIRED
                'deltaTimeSessionWindowConfiguration' => [
                    'timeoutInMinutes' => <integer>, // REQUIRED
                ],
            ],
            'ruleName' => '<string>',
        ],
        // ...
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
    'triggers' => [
        [
            'dataset' => [
                'name' => '<string>', // REQUIRED
            ],
            'schedule' => [
                'expression' => '<string>',
            ],
        ],
        // ...
    ],
    'versioningConfiguration' => [
        'maxVersions' => <integer>,
        'unlimited' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

UpdateDatastore

$result = $client->updateDatastore([/* ... */]);
$promise = $client->updateDatastoreAsync([/* ... */]);

Used to update the settings of a data store.

Parameter Syntax

$result = $client->updateDatastore([
    'datastoreName' => '<string>', // REQUIRED
    'datastoreStorage' => [
        'customerManagedS3' => [
            'bucket' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'iotSiteWiseMultiLayerStorage' => [
            'customerManagedS3Storage' => [ // REQUIRED
                'bucket' => '<string>', // REQUIRED
                'keyPrefix' => '<string>',
            ],
        ],
        'serviceManagedS3' => [
        ],
    ],
    'fileFormatConfiguration' => [
        'jsonConfiguration' => [
        ],
        'parquetConfiguration' => [
            'schemaDefinition' => [
                'columns' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

UpdatePipeline

$result = $client->updatePipeline([/* ... */]);
$promise = $client->updatePipelineAsync([/* ... */]);

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Parameter Syntax

$result = $client->updatePipeline([
    'pipelineActivities' => [ // REQUIRED
        [
            'addAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'channel' => [
                'channelName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'datastore' => [
                'datastoreName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
            ],
            'deviceRegistryEnrich' => [
                'attribute' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'thingName' => '<string>', // REQUIRED
            ],
            'deviceShadowEnrich' => [
                'attribute' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'thingName' => '<string>', // REQUIRED
            ],
            'filter' => [
                'filter' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'lambda' => [
                'batchSize' => <integer>, // REQUIRED
                'lambdaName' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'math' => [
                'attribute' => '<string>', // REQUIRED
                'math' => '<string>', // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'removeAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
            'selectAttributes' => [
                'attributes' => ['<string>', ...], // REQUIRED
                'name' => '<string>', // REQUIRED
                'next' => '<string>',
            ],
        ],
        // ...
    ],
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request was not valid.

ResourceNotFoundException:

A resource with the specified name could not be found.

InternalFailureException:

There was an internal failure.

ServiceUnavailableException:

The service is temporarily unavailable.

ThrottlingException:

The request was denied due to request throttling.

LimitExceededException:

The command caused an internal limit to be exceeded.