Amazon Simple Systems Manager (SSM)

{'S3Destination': {'AWSKMSKeyARN': 'string'}}

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

See also: AWS API Documentation

Request Syntax

client.create_resource_data_sync(
    SyncName='string',
    S3Destination={
        'BucketName': 'string',
        'Prefix': 'string',
        'SyncFormat': 'JsonSerDe',
        'Region': 'string',
        'AWSKMSKeyARN': 'string'
    }
)

type SyncName

string

param SyncName

[REQUIRED]

A name for the configuration.

type S3Destination

dict

param S3Destination

[REQUIRED]

Amazon S3 configuration details for the sync.

• BucketName (string) -- [REQUIRED]

  The name of the Amazon S3 bucket where the aggregated data is stored.

• Prefix (string) --

  An Amazon S3 prefix for the bucket.

• SyncFormat (string) -- [REQUIRED]

  A supported sync format. The following format is currently supported: JsonSerDe

• Region (string) -- [REQUIRED]

  The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

• AWSKMSKeyARN (string) --

  The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'ResourceDataSyncItems': {'S3Destination': {'AWSKMSKeyARN': 'string'}}}

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync . You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

See also: AWS API Documentation

Request Syntax

client.list_resource_data_sync(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

A token to start the list. Use this token to get the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

rtype

dict

returns

Response Syntax

{
    'ResourceDataSyncItems': [
        {
            'SyncName': 'string',
            'S3Destination': {
                'BucketName': 'string',
                'Prefix': 'string',
                'SyncFormat': 'JsonSerDe',
                'Region': 'string',
                'AWSKMSKeyARN': 'string'
            },
            'LastSyncTime': datetime(2015, 1, 1),
            'LastSuccessfulSyncTime': datetime(2015, 1, 1),
            'LastStatus': 'Successful'|'Failed'|'InProgress',
            'SyncCreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ResourceDataSyncItems (list) --

    A list of your current Resource Data Sync configurations and their statuses.

    • (dict) --

      Information about a Resource Data Sync configuration, including its current status and last successful sync.

      • SyncName (string) --

        The name of the Resource Data Sync.

      • S3Destination (dict) --

        Configuration information for the target Amazon S3 bucket.

        • BucketName (string) --

          The name of the Amazon S3 bucket where the aggregated data is stored.

        • Prefix (string) --

          An Amazon S3 prefix for the bucket.

        • SyncFormat (string) --

          A supported sync format. The following format is currently supported: JsonSerDe

        • Region (string) --

          The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

        • AWSKMSKeyARN (string) --

          The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket.

      • LastSyncTime (datetime) --

        The last time the configuration attempted to sync (UTC).

      • LastSuccessfulSyncTime (datetime) --

        The last time the sync operations returned a status of SUCCESSFUL (UTC).

      • LastStatus (string) --

        The status reported by the last sync.

      • SyncCreatedTime (datetime) --

        The date and time the configuration was created (UTC).

  • NextToken (string) --

    The token for the next set of items to return. Use this token to get the next set of results.

{'ClientToken': 'string'}

Initiates execution of an Automation document.

See also: AWS API Documentation

Request Syntax

client.start_automation_execution(
    DocumentName='string',
    DocumentVersion='string',
    Parameters={
        'string': [
            'string',
        ]
    },
    ClientToken='string'
)

type DocumentName

string

param DocumentName

[REQUIRED]

The name of the Automation document to use for this execution.

type DocumentVersion

string

param DocumentVersion

The version of the Automation document to use for this execution.

type Parameters

dict

param Parameters

A key-value map of execution parameters, which match the declared parameters in the Automation document.

• (string) --

  • (list) --

    • (string) --

type ClientToken

string

param ClientToken

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

rtype

dict

returns

Response Syntax

{
    'AutomationExecutionId': 'string'
}

Response Structure

• (dict) --

  • AutomationExecutionId (string) --

    The unique ID of a newly scheduled automation execution.