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 . marketplace-deployment ]

put-deployment-parameter¶

Description¶

Creates or updates a deployment parameter and is targeted by catalog and agreementId .

Synopsis¶

  put-deployment-parameter
--agreement-id <value>
--catalog <value>
[--client-token <value>]
--deployment-parameter <value>
[--expiration-date <value>]
--product-id <value>
[--tags <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¶

--agreement-id (string)

The unique identifier of the agreement.

--catalog (string)

The catalog related to the request. Fixed value: AWS Marketplace

--client-token (string)

The idempotency token for deployment parameters. A unique identifier for the new version.

--deployment-parameter (structure)

The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secret Manager resource.

name -> (string)

The desired name of the deployment parameter. This is the identifier on which deployment parameters are keyed for a given buyer and product. If this name matches an existing deployment parameter, this request will update the existing resource.

secretString -> (string)

The text to encrypt and store in the secret.

Shorthand Syntax:

name=string,secretString=string

JSON Syntax:

{
  "name": "string",
  "secretString": "string"
}

--expiration-date (timestamp)

The date when deployment parameters expire and are scheduled for deletion.

--product-id (string)

The product for which AWS Marketplace will save secrets for the buyer’s account.

--tags (map)

A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

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

agreementId -> (string)

The unique identifier of the agreement.

deploymentParameterId -> (string)

The unique identifier of the deployment parameter.

resourceArn -> (string)

The Amazon Resource Name (ARN) associated with the deployment parameter resource you want to create or update.

tags -> (map)