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 ]

get-subscription-grant

Description

Gets the subscription grant in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  get-subscription-grant
--domain-identifier <value>
--identifier <value>
[--cli-input-json <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

--domain-identifier (string)

The ID of the Amazon DataZone domain in which the subscription grant exists.

--identifier (string)

The ID of the subscription grant.

--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.

--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

assets -> (list)

The assets for which the subscription grant is created.

(structure)

The details of the asset for which the subscription grant is created.

assetId -> (string)

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

assetRevision -> (string)

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

assetScope -> (structure)

The asset scope of the subscribed asset.

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.

failureCause -> (structure)

The failure cause included in the details of the asset for which the subscription grant is created.

message -> (string)

The description of the error message.

failureTimestamp -> (timestamp)

The failure timestamp included in the details of the asset for which the subscription grant is created.

grantedTimestamp -> (timestamp)

The timestamp of when the subscription grant to the asset is created.

status -> (string)

The status of the asset for which the subscription grant is created.

targetName -> (string)

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

createdAt -> (timestamp)

The timestamp of when the subscription grant is created.

createdBy -> (string)

The Amazon DataZone user who created the subscription grant.

domainId -> (string)

The ID of the Amazon DataZone domain in which the subscription grant exists.

grantedEntity -> (tagged union structure)

The entity to which the subscription is granted.

Note

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

listing -> (structure)

The listing for which a subscription is granted.

id -> (string)

An identifier of a revision of an asset published in a Amazon DataZone catalog.

revision -> (string)

The details of a revision of an asset published in a Amazon DataZone catalog.

id -> (string)

The ID of the subscription grant.

status -> (string)

The status of the subscription grant.

subscriptionId -> (string)

The identifier of the subscription.

subscriptionTargetId -> (string)

The subscription target ID associated with the subscription grant.

updatedAt -> (timestamp)

The timestamp of when the subscription grant was upated.

updatedBy -> (string)

The Amazon DataZone user who updated the subscription grant.