Amazonka.MarketplaceCatalog.StartChangeSet

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.

Creating a Request

data StartChangeSet

See: newStartChangeSet smart constructor.

Constructors

StartChangeSet'

Fields

• changeSetName :: Maybe Text

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

• changeSetTags :: Maybe (NonEmpty Tag)

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

• clientRequestToken :: Maybe Text

  A unique token to identify the request to ensure idempotency.

• catalog :: Text

  The catalog related to the request. Fixed value: AWSMarketplace

• changeSet :: NonEmpty Change

  Array of change object.

Instances

ToJSON StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

toJSON :: StartChangeSet -> Value

toEncoding :: StartChangeSet -> Encoding

toJSONList :: [StartChangeSet] -> Value

toEncodingList :: [StartChangeSet] -> Encoding

ToHeaders StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

toHeaders :: StartChangeSet -> [Header]

ToPath StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

toPath :: StartChangeSet -> ByteString

ToQuery StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

toQuery :: StartChangeSet -> QueryString

AWSRequest StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Associated Types

type AWSResponse StartChangeSet

Methods

request :: (Service -> Service) -> StartChangeSet -> Request StartChangeSet

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartChangeSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartChangeSet)))

Generic StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Associated Types

type Rep StartChangeSet :: Type -> Type

Methods

from :: StartChangeSet -> Rep StartChangeSet x

to :: Rep StartChangeSet x -> StartChangeSet

Read StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

readsPrec :: Int -> ReadS StartChangeSet

readList :: ReadS [StartChangeSet]

readPrec :: ReadPrec StartChangeSet

readListPrec :: ReadPrec [StartChangeSet]

Show StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

showsPrec :: Int -> StartChangeSet -> ShowS

show :: StartChangeSet -> String

showList :: [StartChangeSet] -> ShowS

NFData StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

rnf :: StartChangeSet -> ()

Eq StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

(==) :: StartChangeSet -> StartChangeSet -> Bool

(/=) :: StartChangeSet -> StartChangeSet -> Bool

Hashable StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

hashWithSalt :: Int -> StartChangeSet -> Int

hash :: StartChangeSet -> Int

type AWSResponse StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

type AWSResponse StartChangeSet = StartChangeSetResponse

type Rep StartChangeSet

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

type Rep StartChangeSet = D1 ('MetaData "StartChangeSet" "Amazonka.MarketplaceCatalog.StartChangeSet" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "StartChangeSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "changeSetTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "catalog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Change))))))

newStartChangeSet

Arguments

:: Text

$sel:catalog:StartChangeSet'

-> NonEmpty Change

$sel:changeSet:StartChangeSet'

-> StartChangeSet

Create a value of StartChangeSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartChangeSet, startChangeSet_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.

$sel:changeSetTags:StartChangeSet', startChangeSet_changeSetTags - A list of objects specifying each key name and value for the ChangeSetTags property.

$sel:clientRequestToken:StartChangeSet', startChangeSet_clientRequestToken - A unique token to identify the request to ensure idempotency.

$sel:catalog:StartChangeSet', startChangeSet_catalog - The catalog related to the request. Fixed value: AWSMarketplace

$sel:changeSet:StartChangeSet', startChangeSet_changeSet - Array of change object.

Request Lenses

startChangeSet_changeSetName :: Lens' StartChangeSet (Maybe Text)

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

startChangeSet_changeSetTags :: Lens' StartChangeSet (Maybe (NonEmpty Tag))

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

startChangeSet_clientRequestToken :: Lens' StartChangeSet (Maybe Text)

A unique token to identify the request to ensure idempotency.

startChangeSet_catalog :: Lens' StartChangeSet Text

The catalog related to the request. Fixed value: AWSMarketplace

startChangeSet_changeSet :: Lens' StartChangeSet (NonEmpty Change)

Array of change object.

Destructuring the Response

data StartChangeSetResponse

See: newStartChangeSetResponse smart constructor.

Constructors

StartChangeSetResponse'

Fields

• changeSetArn :: Maybe Text

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

• changeSetId :: Maybe Text

  Unique identifier generated for the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Associated Types

type Rep StartChangeSetResponse :: Type -> Type

Methods

from :: StartChangeSetResponse -> Rep StartChangeSetResponse x

to :: Rep StartChangeSetResponse x -> StartChangeSetResponse

Read StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

readsPrec :: Int -> ReadS StartChangeSetResponse

readList :: ReadS [StartChangeSetResponse]

readPrec :: ReadPrec StartChangeSetResponse

readListPrec :: ReadPrec [StartChangeSetResponse]

Show StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

showsPrec :: Int -> StartChangeSetResponse -> ShowS

show :: StartChangeSetResponse -> String

showList :: [StartChangeSetResponse] -> ShowS

NFData StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

rnf :: StartChangeSetResponse -> ()

Eq StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

Methods

(==) :: StartChangeSetResponse -> StartChangeSetResponse -> Bool

(/=) :: StartChangeSetResponse -> StartChangeSetResponse -> Bool

type Rep StartChangeSetResponse

Defined in Amazonka.MarketplaceCatalog.StartChangeSet

type Rep StartChangeSetResponse = D1 ('MetaData "StartChangeSetResponse" "Amazonka.MarketplaceCatalog.StartChangeSet" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "StartChangeSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeSetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "changeSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartChangeSetResponse

Arguments

:: Int

$sel:httpStatus:StartChangeSetResponse'

-> StartChangeSetResponse

Create a value of StartChangeSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartChangeSetResponse, startChangeSetResponse_changeSetArn - The ARN associated to the unique identifier generated for the request.

StartChangeSetResponse, startChangeSetResponse_changeSetId - Unique identifier generated for the request.

$sel:httpStatus:StartChangeSetResponse', startChangeSetResponse_httpStatus - The response's http status code.

Response Lenses

startChangeSetResponse_changeSetArn :: Lens' StartChangeSetResponse (Maybe Text)

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

startChangeSetResponse_changeSetId :: Lens' StartChangeSetResponse (Maybe Text)

Unique identifier generated for the request.

startChangeSetResponse_httpStatus :: Lens' StartChangeSetResponse Int

The response's http status code.