SSM / Client / list_resource_data_sync

list_resource_data_sync#

SSM.Client.list_resource_data_sync(**kwargs)#

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 Syntax

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

Parameters:

SyncType (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.
NextToken (string) – A token to start the list. Use this token to get the next set of results.
MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceDataSyncItems': [
        {
            'SyncName': 'string',
            'SyncType': 'string',
            'SyncSource': {
                'SourceType': 'string',
                'AwsOrganizationsSource': {
                    'OrganizationSourceType': 'string',
                    'OrganizationalUnits': [
                        {
                            'OrganizationalUnitId': 'string'
                        },
                    ]
                },
                'SourceRegions': [
                    'string',
                ],
                'IncludeFutureRegions': True|False,
                'State': 'string',
                'EnableAllOpsDataSources': True|False
            },
            'S3Destination': {
                'BucketName': 'string',
                'Prefix': 'string',
                'SyncFormat': 'JsonSerDe',
                'Region': 'string',
                'AWSKMSKeyARN': 'string',
                'DestinationDataSharing': {
                    'DestinationDataSharingType': 'string'
                }
            },
            'LastSyncTime': datetime(2015, 1, 1),
            'LastSuccessfulSyncTime': datetime(2015, 1, 1),
            'SyncLastModifiedTime': datetime(2015, 1, 1),
            'LastStatus': 'Successful'|'Failed'|'InProgress',
            'SyncCreatedTime': datetime(2015, 1, 1),
            'LastSyncStatusMessage': 'string'
        },
    ],
    '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.
    - 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 (dict) –
      
      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 (dict) –
        
        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.
        
        (dict) –
        
        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 Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
    - S3Destination (dict) –
      
      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 (dict) –
        
        Enables destination data sharing. By default, this field is null.
        
        DestinationDataSharingType (string) –
        
        The sharing data type. Only Organization is supported.
    - 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).
    - SyncLastModifiedTime (datetime) –
      
      The date and time the resource data sync was changed.
    - LastStatus (string) –
      
      The status reported by the last sync.
    - SyncCreatedTime (datetime) –
      
      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.

Exceptions

SSM.Client.exceptions.ResourceDataSyncInvalidConfigurationException
SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.InvalidNextToken