Lists Amazon DataZone subscription requests¶

Description¶

Lists Amazon DataZone subscription requests.

Usage¶

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

Arguments¶

domainIdentifier

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

Specifies the status of the subscription requests.

This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.
subscribedListingId

The identifier of the subscribed listing.
owningProjectId

The identifier of the project for the subscription requests.
owningIamPrincipalArn

The ARN of the owning IAM principal.
approverProjectId

The identifier of the subscription request approver's project.
owningUserId

The ID of the owning user.
owningGroupId

The ID of the owning group.
sortBy

Specifies the way to sort the results of this action.
sortOrder

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

The maximum number of subscription requests to return in a single call to list_subscription_requests. When the number of subscription requests 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_requests to list the next set of subscription requests.
nextToken

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

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      createdBy = "string",
      updatedBy = "string",
      domainId = "string",
      status = "PENDING"|"ACCEPTED"|"REJECTED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      requestReason = "string",
      subscribedPrincipals = list(
        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"
          )
        )
      ),
      subscribedListings = list(
        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"
        )
      ),
      reviewerId = "string",
      decisionComment = "string",
      existingSubscriptionId = "string",
      metadataFormsSummary = list(
        list(
          formName = "string",
          typeName = "string",
          typeRevision = "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_subscription_requests(
  domainIdentifier = "string",
  status = "PENDING"|"ACCEPTED"|"REJECTED",
  subscribedListingId = "string",
  owningProjectId = "string",
  owningIamPrincipalArn = "string",
  approverProjectId = "string",
  owningUserId = "string",
  owningGroupId = "string",
  sortBy = "CREATED_AT"|"UPDATED_AT",
  sortOrder = "ASCENDING"|"DESCENDING",
  maxResults = 123,
  nextToken = "string"
)