list-resource-data-sync¶

Description¶

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.

Synopsis¶

  list-resource-data-sync
[--sync-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--sync-type (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list your resource data sync configurations

This example retrieves information about your resource data sync configurations.

Command:

aws ssm list-resource-data-sync --sync-name "ssm-resource-data-sync"

Output:

{
  "ResourceDataSyncItems": [
      {
          "SyncName": "ssm-resource-data-sync",
          "S3Destination": {
              "BucketName": "ssm-resource-data-sync",
              "SyncFormat": "JsonSerDe",
              "Region": "us-east-1"
          },
          "LastSyncTime": 1550261472.003,
          "LastSuccessfulSyncTime": 1550261472.003,
          "LastStatus": "Successful",
          "SyncCreatedTime": 1543235736.72,
          "LastSyncStatusMessage": "The sync was successfully completed"
      }
  ]
}

Output¶

ResourceDataSyncItems -> (list)

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

(structure)

Information about a resource data sync configuration, including its current status and last successful sync.

SyncName -> (string)

The name of the resource data sync.

SyncType -> (string)

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.

SyncSource -> (structure)

Information about the source where the data was synchronized.

SourceType -> (string)

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

AwsOrganizationsSource -> (structure)

The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.

OrganizationSourceType -> (string)

If an Amazon Web Services organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire Amazon Web Services organization.

OrganizationalUnits -> (list)

The Organizations organization units included in the sync.

(structure)

The Organizations organizational unit data source for the sync.

OrganizationalUnitId -> (string)

The Organizations unit ID data source for the sync.

SourceRegions -> (list)

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

(string)

IncludeFutureRegions -> (boolean)

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

State -> (string)

The data type name for including resource data sync state. There are four sync states:

OrganizationNotExists : Your organization doesn’t exist.

NoPermissions : The system can’t locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.

InvalidOrganizationalUnit : You specified or selected an invalid unit in the resource data sync configuration.

TrustedAccessDisabled : You disabled Systems Manager access in the organization in Organizations.

EnableAllOpsDataSources -> (boolean)

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 .

S3Destination -> (structure)

Configuration information for the target S3 bucket.

BucketName -> (string)

The name of the 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 Amazon Web Services Region with the 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 S3 bucket.

DestinationDataSharing -> (structure)

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

DestinationDataSharingType -> (string)

The sharing data type. Only Organization is supported.

LastSyncTime -> (timestamp)

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

LastSuccessfulSyncTime -> (timestamp)

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

SyncLastModifiedTime -> (timestamp)

The date and time the resource data sync was changed.

LastStatus -> (string)

The status reported by the last sync.

SyncCreatedTime -> (timestamp)

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

LastSyncStatusMessage -> (string)

The status message details reported by the last sync.

NextToken -> (string)

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

Table of Contents

Feedback

User Guide