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.
create-subscription-request¶
Synopsis¶
create-subscription-request
[--client-token <value>]
--domain-identifier <value>
[--metadata-forms <value>]
--request-reason <value>
--subscribed-listings <value>
--subscribed-principals <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¶
--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 request is created.
--metadata-forms (list)
The metadata form included in the subscription request.
(structure)
The details of a metadata form.
content -> (string)
The content of the metadata form.formName -> (string)
The name of the metadata form.typeIdentifier -> (string)
The ID of the metadata form type.typeRevision -> (string)
The revision of the metadata form type.
Shorthand Syntax:
content=string,formName=string,typeIdentifier=string,typeRevision=string ...
JSON Syntax:
[
{
"content": "string",
"formName": "string",
"typeIdentifier": "string",
"typeRevision": "string"
}
...
]
--request-reason (string)
The reason for the subscription request.
--subscribed-listings (list)
The published asset for which the subscription grant is to be created.
(structure)
The published asset for which the subscription grant is to be created.
identifier -> (string)
The identifier of the published asset for which the subscription grant is to be created.
Shorthand Syntax:
identifier=string ...
JSON Syntax:
[
{
"identifier": "string"
}
...
]
--subscribed-principals (list)
The Amazon DataZone principals for whom the subscription request is created.
(tagged union structure)
The principal that is to be given a subscriptiong grant.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:project.project -> (structure)
The project that is to be given a subscription grant.
identifier -> (string)
The identifier of the project that is to be given a subscription grant.
Shorthand Syntax:
project={identifier=string} ...
JSON Syntax:
[
{
"project": {
"identifier": "string"
}
}
...
]
--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¶
createdAt -> (timestamp)
A timestamp of when the subscription request is created.
createdBy -> (string)
The Amazon DataZone user who created the subscription request.
decisionComment -> (string)
The decision comment of the subscription request.
domainId -> (string)
The ID of the Amazon DataZone domain in whcih the subscription request is created.
existingSubscriptionId -> (string)
The ID of the existing subscription.
id -> (string)
The ID of the subscription request.
metadataForms -> (list)
The metadata form included in the subscription request.
(structure)
The details of a metadata form.
content -> (string)
The content of the metadata form.formName -> (string)
The name of the metadata form.typeName -> (string)
The name of the metadata form type.typeRevision -> (string)
The revision of the metadata form type.
requestReason -> (string)
The reason for the subscription request.
reviewerId -> (string)
The ID of the reviewer of the subscription request.
status -> (string)
The status of the subscription request.
subscribedListings -> (list)
The published asset for which the subscription grant is to be created.
(structure)
The details of the published asset for which the subscription grant is created.
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.
subscribedPrincipals -> (list)
The subscribed principals of the subscription request.
(tagged union structure)
The principal that has the subscription grant for the asset.
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.
updatedAt -> (timestamp)
The timestamp of when the subscription request was updated.
updatedBy -> (string)
The Amazon DataZone user who updated the subscription request.