Skip to content

Start Change Set

marketplacecatalog_start_change_set R Documentation

Allows you to request changes for your entities

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.

Usage

marketplacecatalog_start_change_set(Catalog, ChangeSet, ChangeSetName,
  ClientRequestToken, ChangeSetTags, Intent)

Arguments

Catalog

[required] The catalog related to the request. Fixed value: AWSMarketplace
ChangeSet

[required] Array of change object.
ChangeSetName

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

A unique token to identify the request to ensure idempotency.
ChangeSetTags

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

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.

Value

A list with the following syntax:

list(
  ChangeSetId = "string",
  ChangeSetArn = "string"
)

Request syntax

svc$start_change_set(
  Catalog = "string",
  ChangeSet = list(
    list(
      ChangeType = "string",
      Entity = list(
        Type = "string",
        Identifier = "string"
      ),
      EntityTags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Details = "string",
      DetailsDocument = list(),
      ChangeName = "string"
    )
  ),
  ChangeSetName = "string",
  ClientRequestToken = "string",
  ChangeSetTags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Intent = "VALIDATE"|"APPLY"
)