AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

list-subscriptions

Description

Lists subscriptions in Amazon DataZone.

See also: AWS API Documentation

list-subscriptions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: items

Synopsis

  list-subscriptions
[--approver-project-id <value>]
--domain-identifier <value>
[--owning-project-id <value>]
[--sort-by <value>]
[--sort-order <value>]
[--status <value>]
[--subscribed-listing-id <value>]
[--subscription-request-identifier <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--approver-project-id (string)

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

--domain-identifier (string)

The identifier of the Amazon DataZone domain.

--owning-project-id (string)

The identifier of the owning project.

--sort-by (string)

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

Possible values:

  • CREATED_AT
  • UPDATED_AT

--sort-order (string)

Specifies the sort order for the results of this action.

Possible values:

  • ASCENDING
  • DESCENDING

--status (string)

The status of the subscriptions that you want to list.

Note

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

Possible values:

  • APPROVED
  • REVOKED
  • CANCELLED

--subscribed-listing-id (string)

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

--subscription-request-identifier (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

items -> (list)

The results of the ListSubscriptions action.

(structure)

The details of the subscription.

createdAt -> (timestamp)

The timestamp of when the subscription was created.

createdBy -> (string)

The Amazon DataZone user who created the subscription.

domainId -> (string)

The identifier of the Amazon DataZone domain in which a subscription exists.

id -> (string)

The identifier of the subscription.

retainPermissions -> (boolean)

The retain permissions included in the subscription.

status -> (string)

The status of the subscription.

subscribedListing -> (structure)

The listing included in the subscription.

description -> (string)

The description of the published asset for which the subscription grant is created.

id -> (string)

The identifier of the published asset for which the subscription grant is created.

item -> (tagged union structure)

The published asset for which the subscription grant is created.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: assetListing, productListing.

assetListing -> (structure)

The asset for which the subscription grant is created.

assetScope -> (structure)

The asset scope of the subscribed asset listing.

assetId -> (string)

The asset ID of the asset scope.

errorMessage -> (string)

The error message of the asset scope.

filterIds -> (list)

The filter IDs of the asset scope.

(string)

status -> (string)

The status of the asset scope.

entityId -> (string)

The identifier of the published asset for which the subscription grant is created.

entityRevision -> (string)

The revision of the published asset for which the subscription grant is created.

entityType -> (string)

The type of the published asset for which the subscription grant is created.

forms -> (string)

The forms attached to the published asset for which the subscription grant is created.

glossaryTerms -> (list)

The glossary terms attached to the published asset for which the subscription grant is created.

(structure)

Details of a glossary term attached to the inventory asset.

name -> (string)

The name of a glossary term attached to the inventory asset.

shortDescription -> (string)

The shoft description of a glossary term attached to the inventory asset.

productListing -> (structure)

The data product listing.

assetListings -> (list)

The data assets of the data product listing.

(structure)

The listing of the asset in a data product.

entityId -> (string)

The entity ID of the listing of the asset in a data product.

entityRevision -> (string)

The entity revision of the listing of the asset in a data product.

entityType -> (string)

The entity type of the listing of the asset in a data product.

description -> (string)

The description of the data product listing.

entityId -> (string)

The ID of the data product listing.

entityRevision -> (string)

The revision of the data product listing.

glossaryTerms -> (list)

The glossary terms of the data product listing.

(structure)

Details of a glossary term attached to the inventory asset.

name -> (string)

The name of a glossary term attached to the inventory asset.

shortDescription -> (string)

The shoft description of a glossary term attached to the inventory asset.

name -> (string)

The name of the data product listing.

name -> (string)

The name of the published asset for which the subscription grant is created.

ownerProjectId -> (string)

The identifier of the project of the published asset for which the subscription grant is created.

ownerProjectName -> (string)

The name of the project that owns the published asset for which the subscription grant is created.

revision -> (string)

The revision of the published asset for which the subscription grant is created.

subscribedPrincipal -> (tagged union structure)

The principal included in the subscription.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: project.

project -> (structure)

The project that has the subscription grant.

id -> (string)

The identifier of the project that has the subscription grant.

name -> (string)

The name of the project that has the subscription grant.

subscriptionRequestId -> (string)

The identifier of the subscription request for the subscription.

updatedAt -> (timestamp)

The timestamp of when the subscription was updated.

updatedBy -> (string)

The Amazon DataZone user who updated the subscription.

nextToken -> (string)

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 ListSubscriptions to list the next set of subscriptions.