ssm_list_resource_data_sync: Lists your resource data sync configurations

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

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 list_resource_data_sync. 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.

Usage

1
ssm_list_resource_data_sync(SyncType, NextToken, MaxResults)

Arguments

SyncType

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 AWS Organizations or from multiple AWS Regions.

NextToken

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

MaxResults

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
list(
  ResourceDataSyncItems = list(
    list(
      SyncName = "string",
      SyncType = "string",
      SyncSource = list(
        SourceType = "string",
        AwsOrganizationsSource = list(
          OrganizationSourceType = "string",
          OrganizationalUnits = list(
            list(
              OrganizationalUnitId = "string"
            )
          )
        ),
        SourceRegions = list(
          "string"
        ),
        IncludeFutureRegions = TRUE|FALSE,
        State = "string"
      ),
      S3Destination = list(
        BucketName = "string",
        Prefix = "string",
        SyncFormat = "JsonSerDe",
        Region = "string",
        AWSKMSKeyARN = "string",
        DestinationDataSharing = list(
          DestinationDataSharingType = "string"
        )
      ),
      LastSyncTime = as.POSIXct(
        "2015-01-01"
      ),
      LastSuccessfulSyncTime = as.POSIXct(
        "2015-01-01"
      ),
      SyncLastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastStatus = "Successful"|"Failed"|"InProgress",
      SyncCreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastSyncStatusMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
svc$list_resource_data_sync(
  SyncType = "string",
  NextToken = "string",
  MaxResults = 123
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.