[ aws . iotanalytics ]

describe-datastore

Description

Retrieves information about a data store.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-datastore
--datastore-name <value>
[--include-statistics | --no-include-statistics]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--datastore-name (string)

The name of the data store

--include-statistics | --no-include-statistics (boolean)

If true, additional statistical information about the data store is included in the response. This feature cannot be used with a data store whose S3 storage is customer-managed.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve information about a data store

The following describe-datastore example displays details, including statistics, for the specified data store.

aws iotanalytics describe-datastore \
    --datastore-name mydatastore \
    --include-statistics

Output:

{
    "datastore": {
        "status": "ACTIVE",
        "name": "mydatastore",
        "lastUpdateTime": 1557858971.02,
        "creationTime": 1557858971.02,
        "retentionPeriod": {
            "unlimited": true
        },
        "arn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore"
    },
    "statistics": {
        "size": {
            "estimatedSizeInBytes": 397.0,
            "estimatedOn": 1561592040.0
        }
    }
}

For more information, see DescribeDatastore in the AWS IoT Analytics API Reference.

Output

datastore -> (structure)

Information about the data store.

name -> (string)

The name of the data store.

storage -> (structure)

Where data store data is stored. You may choose one of “serviceManagedS3” or “customerManagedS3” storage. If not specified, the default is “serviceManagedS3”. This cannot be changed after the data store is created.

serviceManagedS3 -> (structure)

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

customerManagedS3 -> (structure)

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the “retentionPeriod” parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

bucket -> (string)

The name of the Amazon S3 bucket in which data store data is stored.

keyPrefix -> (string)

[Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a ‘/’.

roleArn -> (string)

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

arn -> (string)

The ARN of the data store.

status -> (string)

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

retentionPeriod -> (structure)

How long, in days, message data is kept for the data store. When “customerManagedS3” storage is selected, this parameter is ignored.

unlimited -> (boolean)

If true, message data is kept indefinitely.

numberOfDays -> (integer)

The number of days that message data is kept. The “unlimited” parameter must be false.

creationTime -> (timestamp)

When the data store was created.

lastUpdateTime -> (timestamp)

The last time the data store was updated.

statistics -> (structure)

Additional statistical information about the data store. Included if the ‘includeStatistics’ parameter is set to true in the request.

size -> (structure)

The estimated size of the data store.

estimatedSizeInBytes -> (double)

The estimated size of the resource in bytes.

estimatedOn -> (timestamp)

The time when the estimate of the size of the resource was made.