List Source Associations

ram_list_source_associations

R Documentation

Lists source associations for resource shares¶

Description¶

Lists source associations for resource shares. Source associations control which sources can be used with service principals in resource shares. This operation provides visibility into source associations for resource share owners.

You can filter the results by resource share Amazon Resource Name (ARN), source ID, source type, or association status. We recommend using pagination to ensure that the operation returns quickly and successfully.

Usage¶

ram_list_source_associations(resourceShareArns, sourceId, sourceType,
  associationStatus, nextToken, maxResults)

Arguments¶

resourceShareArns

The Amazon Resource Names (ARNs) of the resource shares for which you want to retrieve source associations.

sourceId

The identifier of the source for which you want to retrieve associations. This can be an account ID, Amazon Resource Name (ARN), organization ID, or organization path.

sourceType

The type of source for which you want to retrieve associations.

associationStatus

The status of the source associations that you want to retrieve.

nextToken

The pagination token that indicates the next set of results to retrieve.

maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Value¶

A list with the following syntax:

list(
  sourceAssociations = list(
    list(
      resourceShareArn = "string",
      sourceId = "string",
      sourceType = "string",
      status = "string",
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      statusMessage = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_source_associations(
  resourceShareArns = list(
    "string"
  ),
  sourceId = "string",
  sourceType = "string",
  associationStatus = "ASSOCIATING"|"ASSOCIATED"|"FAILED"|"DISASSOCIATING"|"DISASSOCIATED"|"SUSPENDED"|"SUSPENDING"|"RESTORING",
  nextToken = "string",
  maxResults = 123
)