List Subscriptions
datazone_list_subscriptions | R Documentation |
Lists subscriptions in Amazon DataZone¶
Description¶
Lists subscriptions in Amazon DataZone.
Usage¶
datazone_list_subscriptions(approverProjectId, domainIdentifier,
maxResults, nextToken, owningProjectId, sortBy, sortOrder, status,
subscribedListingId, subscriptionRequestIdentifier)
Arguments¶
approverProjectId
The identifier of the project for the subscription's approver.
domainIdentifier
[required] The identifier of the Amazon DataZone domain.
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 ofMaxResults
, the response contains aNextToken
value that you can use in a subsequent call tolist_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 forMaxResults
that is less than the number of subscriptions, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call tolist_subscriptions
to list the next set of subscriptions.owningProjectId
The identifier of the owning project.
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.
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.
subscriptionRequestIdentifier
The identifier of the subscription request for the subscriptions that you want to list.
Value¶
A list with the following syntax:
list(
items = list(
list(
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
domainId = "string",
id = "string",
retainPermissions = TRUE|FALSE,
status = "APPROVED"|"REVOKED"|"CANCELLED",
subscribedListing = list(
description = "string",
id = "string",
item = list(
assetListing = list(
entityId = "string",
entityRevision = "string",
entityType = "string",
forms = "string",
glossaryTerms = list(
list(
name = "string",
shortDescription = "string"
)
)
),
productListing = list(
assetListings = list(
list(
entityId = "string",
entityRevision = "string",
entityType = "string"
)
),
description = "string",
entityId = "string",
entityRevision = "string",
glossaryTerms = list(
list(
name = "string",
shortDescription = "string"
)
),
name = "string"
)
),
name = "string",
ownerProjectId = "string",
ownerProjectName = "string",
revision = "string"
),
subscribedPrincipal = list(
project = list(
id = "string",
name = "string"
)
),
subscriptionRequestId = "string",
updatedAt = as.POSIXct(
"2015-01-01"
),
updatedBy = "string"
)
),
nextToken = "string"
)
Request syntax¶
svc$list_subscriptions(
approverProjectId = "string",
domainIdentifier = "string",
maxResults = 123,
nextToken = "string",
owningProjectId = "string",
sortBy = "CREATED_AT"|"UPDATED_AT",
sortOrder = "ASCENDING"|"DESCENDING",
status = "APPROVED"|"REVOKED"|"CANCELLED",
subscribedListingId = "string",
subscriptionRequestIdentifier = "string"
)