create-subscription-grant¶
Synopsis¶
create-subscription-grant
[--asset-target-names <value>]
[--client-token <value>]
--domain-identifier <value>
--environment-identifier <value>
--granted-entity <value>
--subscription-target-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--asset-target-names (list)
The names of the assets for which the subscription grant is created.
(structure)
The name map for assets.
assetId -> (string)
The identifier of the inventory asset.targetName -> (string)
The target name in the asset target name map.
Shorthand Syntax:
assetId=string,targetName=string ...
JSON Syntax:
[
{
"assetId": "string",
"targetName": "string"
}
...
]
--client-token (string)
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
--domain-identifier (string)
The ID of the Amazon DataZone domain in which the subscription grant is created.
--environment-identifier (string)
The ID of the environment in which the subscription grant is created.
--granted-entity (tagged union structure)
The entity to which the subscription is to be 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 to be granted.
identifier -> (string)
An identifier of revision to be made to an asset published in a Amazon DataZone catalog.revision -> (string)
The details of a revision to be made to an asset published in a Amazon DataZone catalog.
Shorthand Syntax:
listing={identifier=string,revision=string}
JSON Syntax:
{
"listing": {
"identifier": "string",
"revision": "string"
}
}
--subscription-target-identifier (string)
The ID of the subscription target for which the subscription grant is created.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
- yaml
- yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
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)
A 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 is created.
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 grant.
subscriptionTargetId -> (string)
The ID of the subscription target for which the subscription grant is created.
updatedAt -> (timestamp)
A timestamp of when the subscription grant was updated.
updatedBy -> (string)
The Amazon DataZone user who updated the subscription grant.