/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SyncName": "string",
    "S3Destination": {
        "BucketName": "string",
        "Prefix": "string",
        "SyncFormat": "JsonSerDe",
        "Region": "string",
        "AWSKMSKeyARN": "string",
        "DestinationDataSharing": {
            "DestinationDataSharingType": "string"
        }
    },
    "SyncType": "string",
    "SyncSource": {
        "SourceType": "string",
        "AwsOrganizationsSource": {
            "OrganizationSourceType": "string",
            "OrganizationalUnits": []
        },
        "SourceRegions": [],
        "IncludeFutureRegions": true,
        "EnableAllOpsDataSources": true
    }
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

SyncName

string

required

A name for the configuration.

>= 1 characters<= 64 characters

S3Destination

object

optional

Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

BucketName

string

required

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

>= 1 characters<= 2048 characters

Prefix

string

optional

An Amazon S3 prefix for the bucket.

>= 1 characters<= 256 characters

SyncFormat

enum<string>

required

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

Allowed value:

JsonSerDe

Region

string

required

The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.

>= 1 characters<= 64 characters

AWSKMSKeyARN

string

optional

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

>= 1 characters<= 512 characters

Match pattern:

arn:.*

DestinationDataSharing

object

optional

Enables destination data sharing. By default, this field is null.

SyncType

string

optional

Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

>= 1 characters<= 64 characters

SyncSource

object

optional

Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

SourceType

string

required

The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.

>= 1 characters<= 64 characters

AwsOrganizationsSource

object

optional

Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations.

SourceRegions

array[string]

required

The SyncSource Amazon Web Services Regions included in the resource data sync.

IncludeFutureRegions

boolean

optional

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

EnableAllOpsDataSources

boolean

optional

When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InternalServerError

🟠481ResourceDataSyncCountExceededException

🟠482ResourceDataSyncAlreadyExistsException

🟠483ResourceDataSyncInvalidConfigurationException