Skip to content

aws.ssm.list_resource_data_sync

Example SQL Queries

SELECT * FROM
aws.ssm.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.

Table Definition

Column NameColumn Data Type
sync_type Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
last_status

The status reported by the last sync.

VARCHAR
last_successful_sync_time

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

TIMESTAMP_S
last_sync_status_message

The status message details reported by the last sync.

VARCHAR
last_sync_time

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

TIMESTAMP_S
s3_destination

Configuration information for the target S3 bucket.

STRUCT(
"bucket_name" VARCHAR,
"prefix" VARCHAR,
"sync_format" VARCHAR,
"region" VARCHAR,
"awskms_key_arn" VARCHAR,
"destination_data_sharing" STRUCT(
"destination_data_sharing_type" VARCHAR
)
)
Show child fields
s3_destination.awskms_key_arn

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

s3_destination.bucket_name

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

s3_destination.destination_data_sharing

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

Show child fields
s3_destination.destination_data_sharing.destination_data_sharing_type

The sharing data type. Only Organization is supported.

s3_destination.prefix

An Amazon S3 prefix for the bucket.

s3_destination.region

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

s3_destination.sync_format

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

sync_created_time

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

TIMESTAMP_S
sync_last_modified_time

The date and time the resource data sync was changed.

TIMESTAMP_S
sync_name

The name of the resource data sync.

VARCHAR
sync_source

Information about the source where the data was synchronized.

STRUCT(
"source_type" VARCHAR,
"aws_organizations_source" STRUCT(
"organization_source_type" VARCHAR,
"organizational_units" STRUCT(
"organizational_unit_id" VARCHAR
)[]
),
"source_regions" VARCHAR[],
"include_future_regions" BOOLEAN,
"state" VARCHAR,
"enable_all_ops_data_sources" BOOLEAN
)
Show child fields
sync_source.aws_organizations_source

The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.

Show child fields
sync_source.aws_organizations_source.organization_source_type

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.

sync_source.aws_organizations_source.organizational_units[]
Show child fields
sync_source.aws_organizations_source.organizational_units[].organizational_unit_id

The Organizations unit ID data source for the sync.

sync_source.enable_all_ops_data_sources

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 Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

sync_source.include_future_regions

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

sync_source.source_regions[]
sync_source.source_type

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

sync_source.state

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.