Lists subscriptions in Amazon DataZone¶

Description¶

Lists subscriptions in Amazon DataZone.

Usage¶

datazone_list_subscriptions(domainIdentifier,
  subscriptionRequestIdentifier, status, subscribedListingId,
  owningProjectId, owningIamPrincipalArn, owningUserId, owningGroupId,
  approverProjectId, sortBy, sortOrder, maxResults, nextToken)

Arguments¶

domainIdentifier

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

The identifier of the subscription request for the subscriptions that you want to list.
status

The status of the subscriptions that you want to list.

This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.
subscribedListingId

The identifier of the subscribed listing for the subscriptions that you want to list.
owningProjectId

The identifier of the owning project.
owningIamPrincipalArn

The ARN of the owning IAM principal.
owningUserId

The ID of the owning user.
owningGroupId

The ID of the owning group.
approverProjectId

The identifier of the project for the subscription's approver.
sortBy

Specifies the way in which the results of this action are to be sorted.
sortOrder

Specifies the sort order for the results of this action.
maxResults

The maximum number of subscriptions to return in a single call to list_subscriptions. When the number of subscriptions 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_subscriptions to list the next set of Subscriptions.
nextToken

When the number of subscriptions 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 subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to list_subscriptions to list the next set of subscriptions.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      createdBy = "string",
      updatedBy = "string",
      domainId = "string",
      status = "APPROVED"|"REVOKED"|"CANCELLED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      subscribedPrincipal = list(
        project = list(
          id = "string",
          name = "string"
        ),
        user = list(
          id = "string",
          details = list(
            iam = list(
              arn = "string",
              principalId = "string",
              sessionName = "string",
              groupProfileId = "string"
            ),
            sso = list(
              username = "string",
              firstName = "string",
              lastName = "string"
            )
          )
        ),
        group = list(
          id = "string",
          name = "string"
        ),
        iam = list(
          principalArn = "string"
        )
      ),
      subscribedListing = list(
        id = "string",
        revision = "string",
        name = "string",
        description = "string",
        item = list(
          assetListing = list(
            entityId = "string",
            entityRevision = "string",
            entityType = "string",
            forms = "string",
            glossaryTerms = list(
              list(
                name = "string",
                shortDescription = "string"
              )
            ),
            assetScope = list(
              assetId = "string",
              filterIds = list(
                "string"
              ),
              status = "string",
              scopeName = "string",
              errorMessage = "string"
            ),
            permissions = list(
              s3 = list(
                "READ"|"WRITE"
              )
            )
          ),
          productListing = list(
            entityId = "string",
            entityRevision = "string",
            glossaryTerms = list(
              list(
                name = "string",
                shortDescription = "string"
              )
            ),
            name = "string",
            description = "string",
            assetListings = list(
              list(
                entityId = "string",
                entityRevision = "string",
                entityType = "string"
              )
            )
          )
        ),
        ownerProjectId = "string",
        ownerProjectName = "string"
      ),
      subscriptionRequestId = "string",
      retainPermissions = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_subscriptions(
  domainIdentifier = "string",
  subscriptionRequestIdentifier = "string",
  status = "APPROVED"|"REVOKED"|"CANCELLED",
  subscribedListingId = "string",
  owningProjectId = "string",
  owningIamPrincipalArn = "string",
  owningUserId = "string",
  owningGroupId = "string",
  approverProjectId = "string",
  sortBy = "CREATED_AT"|"UPDATED_AT",
  sortOrder = "ASCENDING"|"DESCENDING",
  maxResults = 123,
  nextToken = "string"
)