| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MarketplaceCatalog.StartChangeSet
Description
This operation allows you to request changes for your entities. Within a
single ChangeSet, you cannot 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
ChangeSet has completed (either succeeded, cancelled, or failed). If you
try to start a ChangeSet containing a change against an entity that is
already locked, you will receive a ResourceInUseException.
For example, you cannot start the ChangeSet described in the
example
later in this topic, because it contains two changes to execute 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.
Synopsis
- data StartChangeSet = StartChangeSet' {}
- newStartChangeSet :: Text -> NonEmpty Change -> StartChangeSet
- startChangeSet_changeSetName :: Lens' StartChangeSet (Maybe Text)
- startChangeSet_clientRequestToken :: Lens' StartChangeSet (Maybe Text)
- startChangeSet_catalog :: Lens' StartChangeSet Text
- startChangeSet_changeSet :: Lens' StartChangeSet (NonEmpty Change)
- data StartChangeSetResponse = StartChangeSetResponse' {
- changeSetId :: Maybe Text
- changeSetArn :: Maybe Text
- httpStatus :: Int
- newStartChangeSetResponse :: Int -> StartChangeSetResponse
- startChangeSetResponse_changeSetId :: Lens' StartChangeSetResponse (Maybe Text)
- startChangeSetResponse_changeSetArn :: Lens' StartChangeSetResponse (Maybe Text)
- startChangeSetResponse_httpStatus :: Lens' StartChangeSetResponse Int
Creating a Request
data StartChangeSet Source #
See: newStartChangeSet smart constructor.
Constructors
| StartChangeSet' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty Change | |
| -> 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:
$sel:changeSetName: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: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) Source #
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_clientRequestToken :: Lens' StartChangeSet (Maybe Text) Source #
A unique token to identify the request to ensure idempotency.
startChangeSet_catalog :: Lens' StartChangeSet Text Source #
The catalog related to the request. Fixed value: AWSMarketplace
startChangeSet_changeSet :: Lens' StartChangeSet (NonEmpty Change) Source #
Array of change object.
Destructuring the Response
data StartChangeSetResponse Source #
See: newStartChangeSetResponse smart constructor.
Constructors
| StartChangeSetResponse' | |
Fields
| |
Instances
newStartChangeSetResponse Source #
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:
$sel:changeSetId:StartChangeSetResponse', startChangeSetResponse_changeSetId - Unique identifier generated for the request.
$sel:changeSetArn:StartChangeSetResponse', startChangeSetResponse_changeSetArn - The ARN associated to the unique identifier generated for the request.
$sel:httpStatus:StartChangeSetResponse', startChangeSetResponse_httpStatus - The response's http status code.
Response Lenses
startChangeSetResponse_changeSetId :: Lens' StartChangeSetResponse (Maybe Text) Source #
Unique identifier generated for the request.
startChangeSetResponse_changeSetArn :: Lens' StartChangeSetResponse (Maybe Text) Source #
The ARN associated to the unique identifier generated for the request.
startChangeSetResponse_httpStatus :: Lens' StartChangeSetResponse Int Source #
The response's http status code.