Lists subscription grants¶

Description¶

Lists subscription grants.

Usage¶

datazone_list_subscription_grants(domainIdentifier, environmentId,
  subscriptionTargetId, subscribedListingId, subscriptionId,
  owningProjectId, owningIamPrincipalArn, owningUserId, owningGroupId,
  sortBy, sortOrder, maxResults, nextToken)

Arguments¶

domainIdentifier

[required] The identifier of the Amazon DataZone domain.
environmentId

The identifier of the Amazon DataZone environment.
subscriptionTargetId

The identifier of the subscription target.
subscribedListingId

The identifier of the subscribed listing.
subscriptionId

The identifier of the subscription.
owningProjectId

The ID of the owning project of the subscription grants.
owningIamPrincipalArn

The ARN of the owning IAM principal.
owningUserId

The ID of the owning user.
owningGroupId

The ID of the owning group.
sortBy

Specifies the way of sorting the results of this action.
sortOrder

Specifies the sort order of this action.
maxResults

The maximum number of subscription grants to return in a single call to list_subscription_grants. When the number of subscription grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to list_subscription_grants to list the next set of subscription grants.
nextToken

When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to list_subscription_grants to list the next set of subscription grants.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      createdBy = "string",
      updatedBy = "string",
      domainId = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      environmentId = "string",
      subscriptionTargetId = "string",
      grantedEntity = list(
        listing = list(
          id = "string",
          revision = "string"
        )
      ),
      status = "PENDING"|"IN_PROGRESS"|"GRANT_FAILED"|"REVOKE_FAILED"|"GRANT_AND_REVOKE_FAILED"|"COMPLETED"|"INACCESSIBLE",
      assets = list(
        list(
          assetId = "string",
          assetRevision = "string",
          status = "GRANT_PENDING"|"REVOKE_PENDING"|"GRANT_IN_PROGRESS"|"REVOKE_IN_PROGRESS"|"GRANTED"|"REVOKED"|"GRANT_FAILED"|"REVOKE_FAILED",
          targetName = "string",
          failureCause = list(
            message = "string"
          ),
          grantedTimestamp = as.POSIXct(
            "2015-01-01"
          ),
          failureTimestamp = as.POSIXct(
            "2015-01-01"
          ),
          assetScope = list(
            assetId = "string",
            filterIds = list(
              "string"
            ),
            status = "string",
            scopeName = "string",
            errorMessage = "string"
          ),
          permissions = list(
            s3 = list(
              "READ"|"WRITE"
            )
          )
        )
      ),
      subscriptionId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_subscription_grants(
  domainIdentifier = "string",
  environmentId = "string",
  subscriptionTargetId = "string",
  subscribedListingId = "string",
  subscriptionId = "string",
  owningProjectId = "string",
  owningIamPrincipalArn = "string",
  owningUserId = "string",
  owningGroupId = "string",
  sortBy = "CREATED_AT"|"UPDATED_AT",
  sortOrder = "ASCENDING"|"DESCENDING",
  maxResults = 123,
  nextToken = "string"
)