AWS IoT SiteWise

Retrieves information about the storage configuration for IoT SiteWise.

See also: AWS API Documentation

Request Syntax

client.describe_storage_configuration()

rtype:

dict

returns:

Response Syntax

{
    'storageType': 'SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
    'multiLayerStorage': {
        'customerManagedS3Storage': {
            's3ResourceArn': 'string',
            'roleArn': 'string'
        }
    },
    'configurationStatus': {
        'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    },
    'lastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • storageType (string) --

    The type of storage that you specified for your data. The storage type can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

  • multiLayerStorage (dict) --

    Contains information about the storage destination.

    • customerManagedS3Storage (dict) --

      Contains information about a customer managed Amazon S3 bucket.

      • s3ResourceArn (string) --

        The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.

      • roleArn (string) --

        The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.

  • configurationStatus (dict) --

    Contains current status information for the configuration.

    • state (string) --

      The current state of the configuration.

    • error (dict) --

      Contains associated error information, if any.

      • code (string) --

        The error code.

      • message (string) --

        The error message.

  • lastUpdateDate (datetime) --

    The date the storage configuration was last updated, in Unix epoch time.

Configures storage settings for IoT SiteWise.

See also: AWS API Documentation

Request Syntax

client.put_storage_configuration(
    storageType='SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
    multiLayerStorage={
        'customerManagedS3Storage': {
            's3ResourceArn': 'string',
            'roleArn': 'string'
        }
    }
)

type storageType:

string

param storageType:

[REQUIRED]

The type of storage that you specified for your data. The storage type can be one of the following values:

• SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.

• MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

type multiLayerStorage:

dict

param multiLayerStorage:

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

• customerManagedS3Storage (dict) -- [REQUIRED]

  Contains information about a customer managed Amazon S3 bucket.

  • s3ResourceArn (string) -- [REQUIRED]

    The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.

  • roleArn (string) -- [REQUIRED]

    The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.

rtype:

dict

returns:

Response Syntax

{
    'storageType': 'SITEWISE_DEFAULT_STORAGE'|'MULTI_LAYER_STORAGE',
    'multiLayerStorage': {
        'customerManagedS3Storage': {
            's3ResourceArn': 'string',
            'roleArn': 'string'
        }
    },
    'configurationStatus': {
        'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

• (dict) --

  • storageType (string) --

    The type of storage that you specified for your data. The storage type can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified.

  • multiLayerStorage (dict) --

    Contains information about the storage destination.

    • customerManagedS3Storage (dict) --

      Contains information about a customer managed Amazon S3 bucket.

      • s3ResourceArn (string) --

        The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.

      • roleArn (string) --

        The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.

  • configurationStatus (dict) --

    Contains current status information for the configuration.

    • state (string) --

      The current state of the configuration.

    • error (dict) --

      Contains associated error information, if any.

      • code (string) --

        The error code.

      • message (string) --

        The error message.