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

start-change-set

Description

Allows you to request changes for your entities. Within a single ChangeSet , you can't start the same change type against the same entity multiple times. Additionally, when a ChangeSet is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error.

For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same change type (AddRevisions ) against the same entity (entity-id@1 ).

For more information about working with change sets, see Working with change sets . For information about change types for single-AMI products, see Working with single-AMI products . Also, for more information about change types available for container-based products, see Working with container products .

See also: AWS API Documentation

start-change-set uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  start-change-set
--catalog <value>
--change-set <value>
[--change-set-name <value>]
[--client-request-token <value>]
[--change-set-tags <value>]
[--intent <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

--catalog (string)

The catalog related to the request. Fixed value: AWSMarketplace

--change-set (list)

Array of change object.

(structure)

An object that contains the ChangeType , Details , and Entity .

ChangeType -> (string)

Change types are single string values that describe your intention for the change. Each change type is unique for each EntityType provided in the change's scope. For more information about change types available for single-AMI products, see Working with single-AMI products . Also, for more information about change types available for container-based products, see Working with container products .

Entity -> (structure)

The entity to be changed.

Type -> (string)

The type of entity.

Identifier -> (string)

The identifier for the entity.

EntityTags -> (list)

The tags associated with the change.

(structure)

A list of objects specifying each key name and value.

Key -> (string)

The key associated with the tag.

Value -> (string)

The value associated with the tag.

Details -> (string)

This object contains details specific to the change type of the requested change. For more information about change types available for single-AMI products, see Working with single-AMI products . Also, for more information about change types available for container-based products, see Working with container products .

DetailsDocument -> (document)

Alternative field that accepts a JSON value instead of a string for ChangeType details. You can use either Details or DetailsDocument , but not both.

ChangeName -> (string)

Optional name for the change.

Shorthand Syntax:

ChangeType=string,Entity={Type=string,Identifier=string},EntityTags=[{Key=string,Value=string},{Key=string,Value=string}],Details=string,ChangeName=string ...

JSON Syntax:

[
  {
    "ChangeType": "string",
    "Entity": {
      "Type": "string",
      "Identifier": "string"
    },
    "EntityTags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ],
    "Details": "string",
    "DetailsDocument": {...},
    "ChangeName": "string"
  }
  ...
]

--change-set-name (string)

Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.

--client-request-token (string)

A unique token to identify the request to ensure idempotency.

--change-set-tags (list)

A list of objects specifying each key name and value for the ChangeSetTags property.

(structure)

A list of objects specifying each key name and value.

Key -> (string)

The key associated with the tag.

Value -> (string)

The value associated with the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--intent (string)

The intent related to the request. The default is APPLY . To test your request before applying changes to your entities, use VALIDATE . This feature is currently available for adding versions to single-AMI products. For more information, see Add a new version .

Possible values:

  • VALIDATE
  • APPLY

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

ChangeSetId -> (string)

Unique identifier generated for the request.

ChangeSetArn -> (string)

The ARN associated to the unique identifier generated for the request.