AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

update-subscription-target

Description

Updates the specified subscription target in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  update-subscription-target
--domain-identifier <value>
--environment-identifier <value>
--identifier <value>
[--name <value>]
[--authorized-principals <value>]
[--applicable-asset-types <value>]
[--subscription-target-config <value>]
[--manage-access-role <value>]
[--provider <value>]
[--subscription-grant-creation-mode <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>]
[--v2-debug]

Options

--domain-identifier (string)

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

--environment-identifier (string)

The identifier of the environment in which a subscription target is to be updated.

--identifier (string)

Identifier of the subscription target that is to be updated.

--name (string)

The name to be updated as part of the UpdateSubscriptionTarget action.

--authorized-principals (list)

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

(string)

Syntax:

"string" "string" ...

--applicable-asset-types (list)

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

(string)

Syntax:

"string" "string" ...

--subscription-target-config (list)

The configuration to be updated as part of the UpdateSubscriptionTarget action.

(structure)

The details of the subscription target configuration.

formName -> (string)

The form name included in the subscription target configuration.

content -> (string)

The content of the subscription target configuration.

Shorthand Syntax:

formName=string,content=string ...

JSON Syntax:

[
  {
    "formName": "string",
    "content": "string"
  }
  ...
]

--manage-access-role (string)

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

--provider (string)

The provider to be updated as part of the UpdateSubscriptionTarget action.

--subscription-grant-creation-mode (string)

Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

Possible values:

  • AUTOMATIC
  • MANUAL

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

id -> (string)

Identifier of the subscription target that is to be updated.

authorizedPrincipals -> (list)

The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.

(string)

domainId -> (string)

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

projectId -> (string)

The identifier of the project in which a subscription target is to be updated.

environmentId -> (string)

The identifier of the environment in which a subscription target is to be updated.

name -> (string)

The name to be updated as part of the UpdateSubscriptionTarget action.

type -> (string)

The type to be updated as part of the UpdateSubscriptionTarget action.

createdBy -> (string)

The Amazon DataZone user who created the subscription target.

updatedBy -> (string)

The Amazon DataZone user who updated the subscription target.

createdAt -> (timestamp)

The timestamp of when a subscription target was created.

updatedAt -> (timestamp)

The timestamp of when the subscription target was updated.

manageAccessRole -> (string)

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

applicableAssetTypes -> (list)

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

(string)

subscriptionTargetConfig -> (list)

The configuration to be updated as part of the UpdateSubscriptionTarget action.

(structure)

The details of the subscription target configuration.

formName -> (string)

The form name included in the subscription target configuration.

content -> (string)

The content of the subscription target configuration.

provider -> (string)

The provider to be updated as part of the UpdateSubscriptionTarget action.

subscriptionGrantCreationMode -> (string)

Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.