AWS IoT Analytics

2018/07/18 - AWS IoT Analytics - 2 updated api methods

Changes  This change allows publishing of channel/datastore size as part of the describe-channel/describe-datastore APIs. We introduce an optional boolean parameter 'includeStatistics' in the Describe request. If the user sets this parameter to true, the describe response will return the resource size and timestamp at which the size was recorded. If the parameter is set to false, the size won't be computed or returned.

DescribeChannel (updated) Link ¶
Changes (request, response)
Request 
{'includeStatistics': 'boolean'}
Response 
{'statistics': {'size': {'estimatedOn': 'timestamp',
                         'estimatedSizeInBytes': 'double'}}}

Retrieves information about a channel.

See also: AWS API Documentation

Request Syntax

client.describe_channel(
    channelName='string',
    includeStatistics=True|False
)
type channelName

string

param channelName

[REQUIRED]

The name of the channel whose information is retrieved.

type includeStatistics

boolean

param includeStatistics

If true, include statistics about the channel in the response.

rtype

dict

returns

Response Syntax

{
    'channel': {
        'name': 'string',
        'arn': 'string',
        'status': 'CREATING'|'ACTIVE'|'DELETING',
        'retentionPeriod': {
            'unlimited': True|False,
            'numberOfDays': 123
        },
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1)
    },
    'statistics': {
        'size': {
            'estimatedSizeInBytes': 123.0,
            'estimatedOn': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • channel (dict) --

      An object that contains information about the channel.

      • name (string) --

        The name of the channel.

      • arn (string) --

        The ARN of the channel.

      • status (string) --

        The status of the channel.

      • retentionPeriod (dict) --

        How long, in days, message data is kept for the channel.

        • 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 (datetime) --

        When the channel was created.

      • lastUpdateTime (datetime) --

        When the channel was last updated.

    • statistics (dict) --

      Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.

      • size (dict) --

        The estimated size of the channel.

        • estimatedSizeInBytes (float) --

          The estimated size of the resource in bytes.

        • estimatedOn (datetime) --

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

DescribeDatastore (updated) Link ¶
Changes (request, response)
Request 
{'includeStatistics': 'boolean'}
Response 
{'statistics': {'size': {'estimatedOn': 'timestamp',
                         'estimatedSizeInBytes': 'double'}}}

Retrieves information about a data store.

See also: AWS API Documentation

Request Syntax

client.describe_datastore(
    datastoreName='string',
    includeStatistics=True|False
)
type datastoreName

string

param datastoreName

[REQUIRED]

The name of the data store

type includeStatistics

boolean

param includeStatistics

If true, include statistics about the data store in the response.

rtype

dict

returns

Response Syntax

{
    'datastore': {
        'name': 'string',
        'arn': 'string',
        'status': 'CREATING'|'ACTIVE'|'DELETING',
        'retentionPeriod': {
            'unlimited': True|False,
            'numberOfDays': 123
        },
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1)
    },
    'statistics': {
        'size': {
            'estimatedSizeInBytes': 123.0,
            'estimatedOn': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • datastore (dict) --

      Information about the data store.

      • name (string) --

        The name of the data store.

      • 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 (dict) --

        How long, in days, message data is kept for the data store.

        • 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 (datetime) --

        When the data store was created.

      • lastUpdateTime (datetime) --

        The last time the data store was updated.

    • statistics (dict) --

      Statistics about the data store. Included if the 'includeStatistics' parameter is set to true in the request.

      • size (dict) --

        The estimated size of the data store.

        • estimatedSizeInBytes (float) --

          The estimated size of the resource in bytes.

        • estimatedOn (datetime) --

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