/

The Amazon SSM multi-region endpoint

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

POST

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.

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 '{
    "SyncType": "string",
    "NextToken": "string",
    "MaxResults": 0
}'

Response Example

200 - Example 1

{
    "ResourceDataSyncItems": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

SyncType

string

optional

View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.

>= 1 characters<= 64 characters

NextToken

string

optional

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

MaxResults

integer

optional

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.

>= 1<= 50

Examples

Responses

🟢200Success

application/json

Body

ResourceDataSyncItems

array[object (ResourceDataSyncItem) {10}]

optional

A list of your current resource data sync configurations and their statuses.

SyncName

string

optional

The name of the resource data sync.

>= 1 characters<= 64 characters

SyncType

string

optional

The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from Organizations or from multiple Amazon Web Services Regions.

>= 1 characters<= 64 characters

SyncSource

object

optional

Information about the source where the data was synchronized.

S3Destination

object

optional

Configuration information for the target S3 bucket.

LastSyncTime

string <date-time>

optional

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

LastSuccessfulSyncTime

string <date-time>

optional

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

SyncLastModifiedTime

string <date-time>

optional

The date and time the resource data sync was changed.

LastStatus

enum<string>

optional

The status reported by the last sync.

Allowed values:

SuccessfulFailedInProgress

SyncCreatedTime

string <date-time>

optional

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

LastSyncStatusMessage

string

optional

The status message details reported by the last sync.

NextToken

string

optional

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

🟠480ResourceDataSyncInvalidConfigurationException

🟠481InternalServerError

🟠482InvalidNextToken