SDK for PHP 3.x

Access is denied.

HTTP status code: 403

There was an internal service exception.

HTTP status code: 500

Too many requests.

HTTP status code: 429

An error occurred during validation.

HTTP status code: 422

CancelChangeSet

$result = $client->cancelChangeSet([/* ... */]);
$promise = $client->cancelChangeSetAsync([/* ... */]);

Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

Parameter Syntax

$result = $client->cancelChangeSet([
    'Catalog' => '<string>', // REQUIRED
    'ChangeSetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Required. The catalog related to the request. Fixed value: AWSMarketplace.

ChangeSetId

: Required: Yes
: Type: string

Required. The unique identifier of the StartChangeSet request that you want to cancel.

Result Syntax

[
    'ChangeSetArn' => '<string>',
    'ChangeSetId' => '<string>',
]

Result Details

Members

ChangeSetArn

: Type: string

The ARN associated with the change set referenced in this request.

ChangeSetId

: Type: string

The unique identifier for the change set referenced in this request.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

ResourceInUseException:

The specified resource wasn't found.

HTTP status code: 404

The resource is currently in use.

Too many requests.

HTTP status code: 429

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes a resource-based policy on an entity that is identified by its resource ARN.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

DescribeChangeSet

$result = $client->describeChangeSet([/* ... */]);
$promise = $client->describeChangeSetAsync([/* ... */]);

Provides information about a given change set.

Parameter Syntax

$result = $client->describeChangeSet([
    'Catalog' => '<string>', // REQUIRED
    'ChangeSetId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Required. The catalog related to the request. Fixed value: AWSMarketplace

ChangeSetId

: Required: Yes
: Type: string

Required. The unique identifier for the StartChangeSet request that you want to describe the details for.

Result Syntax

[
    'ChangeSet' => [
        [
            'ChangeName' => '<string>',
            'ChangeType' => '<string>',
            'Details' => '<string>',
            'DetailsDocument' => [
            ],
            'Entity' => [
                'Identifier' => '<string>',
                'Type' => '<string>',
            ],
            'ErrorDetailList' => [
                [
                    'ErrorCode' => '<string>',
                    'ErrorMessage' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ChangeSetArn' => '<string>',
    'ChangeSetId' => '<string>',
    'ChangeSetName' => '<string>',
    'EndTime' => '<string>',
    'FailureCode' => 'CLIENT_ERROR|SERVER_FAULT',
    'FailureDescription' => '<string>',
    'Intent' => 'VALIDATE|APPLY',
    'StartTime' => '<string>',
    'Status' => 'PREPARING|APPLYING|SUCCEEDED|CANCELLED|FAILED',
]

Result Details

Members

ChangeSet

: Type: Array of ChangeSummary structures

An array of ChangeSummary objects.

ChangeSetArn

: Type: string

The ARN associated with the unique identifier for the change set referenced in this request.

ChangeSetId

: Type: string

Required. The unique identifier for the change set referenced in this request.

ChangeSetName

: Type: string

The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.

EndTime

: Type: string

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state.

FailureCode

: Type: string

Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.

FailureDescription

: Type: string

Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

Intent

: Type: string

The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.

StartTime

: Type: string

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

Status

: Type: string

The status of the change request.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

DescribeEntity

$result = $client->describeEntity([/* ... */]);
$promise = $client->describeEntityAsync([/* ... */]);

Returns the metadata and content of the entity.

Parameter Syntax

$result = $client->describeEntity([
    'Catalog' => '<string>', // REQUIRED
    'EntityId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

Required. The catalog related to the request. Fixed value: AWSMarketplace

EntityId

: Required: Yes
: Type: string

Required. The unique ID of the entity to describe.

Result Syntax

[
    'Details' => '<string>',
    'DetailsDocument' => [
    ],
    'EntityArn' => '<string>',
    'EntityIdentifier' => '<string>',
    'EntityType' => '<string>',
    'LastModifiedDate' => '<string>',
]

Result Details

Members

Details

: Type: string

This stringified JSON object includes the details of the entity.

DetailsDocument

: Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The JSON value of the details specific to the entity.

EntityArn

: Type: string

The ARN associated to the unique identifier for the entity referenced in this request.

EntityIdentifier

: Type: string

The identifier of the entity, in the format of EntityId@RevisionId.

EntityType

: Type: string

The named type of the entity, in the format of EntityType@Version.

LastModifiedDate

: Type: string

The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

ResourceNotSupportedException:

An error occurred during validation.

HTTP status code: 422

Currently, the specified resource is not supported.

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Gets a resource-based policy of an entity that is identified by its resource ARN.

Parameter Syntax

$result = $client->getResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

: Type: string

The policy document to set; formatted in JSON.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

ListChangeSets

$result = $client->listChangeSets([/* ... */]);
$promise = $client->listChangeSetsAsync([/* ... */]);

Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId, ChangeSetName, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.

You can describe a change during the 60-day request history retention period for API calls.

Parameter Syntax

$result = $client->listChangeSets([
    'Catalog' => '<string>', // REQUIRED
    'FilterList' => [
        [
            'Name' => '<string>',
            'ValueList' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Sort' => [
        'SortBy' => '<string>',
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

The catalog related to the request. Fixed value: AWSMarketplace

FilterList

: Type: Array of Filter structures

An array of filter objects.

MaxResults

: Type: int

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20.

NextToken

: Type: string

The token value retrieved from a previous call to access the next page of results.

Sort

: Type: Sort structure

An object that contains two attributes, SortBy and SortOrder.

Result Syntax

[
    'ChangeSetSummaryList' => [
        [
            'ChangeSetArn' => '<string>',
            'ChangeSetId' => '<string>',
            'ChangeSetName' => '<string>',
            'EndTime' => '<string>',
            'EntityIdList' => ['<string>', ...],
            'FailureCode' => 'CLIENT_ERROR|SERVER_FAULT',
            'StartTime' => '<string>',
            'Status' => 'PREPARING|APPLYING|SUCCEEDED|CANCELLED|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ChangeSetSummaryList

: Type: Array of ChangeSetSummaryListItem structures

Array of ChangeSetSummaryListItem objects.

NextToken

: Type: string

The value of the next token, if it exists. Null if there are no more results.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

Too many requests.

HTTP status code: 429

ListEntities

$result = $client->listEntities([/* ... */]);
$promise = $client->listEntitiesAsync([/* ... */]);

Provides the list of entities of a given type.

Parameter Syntax

$result = $client->listEntities([
    'Catalog' => '<string>', // REQUIRED
    'EntityType' => '<string>', // REQUIRED
    'EntityTypeFilters' => [
        'AmiProductFilters' => [
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ProductTitle' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Visibility' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
        'ContainerProductFilters' => [
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ProductTitle' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Visibility' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
        'DataProductFilters' => [
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ProductTitle' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Visibility' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
        'OfferFilters' => [
            'AvailabilityEndDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'BuyerAccounts' => [
                'WildCardValue' => '<string>',
            ],
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'Name' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'ProductId' => [
                'ValueList' => ['<string>', ...],
            ],
            'ReleaseDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ResaleAuthorizationId' => [
                'ValueList' => ['<string>', ...],
            ],
            'State' => [
                'ValueList' => ['<string>', ...],
            ],
            'Targeting' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
        'ResaleAuthorizationFilters' => [
            'AvailabilityEndDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
                'ValueList' => ['<string>', ...],
            ],
            'CreatedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
                'ValueList' => ['<string>', ...],
            ],
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ManufacturerAccountId' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'ManufacturerLegalName' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Name' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'OfferExtendedStatus' => [
                'ValueList' => ['<string>', ...],
            ],
            'ProductId' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'ProductName' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'ResellerAccountID' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'ResellerLegalName' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Status' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
        'SaaSProductFilters' => [
            'EntityId' => [
                'ValueList' => ['<string>', ...],
            ],
            'LastModifiedDate' => [
                'DateRange' => [
                    'AfterValue' => '<string>',
                    'BeforeValue' => '<string>',
                ],
            ],
            'ProductTitle' => [
                'ValueList' => ['<string>', ...],
                'WildCardValue' => '<string>',
            ],
            'Visibility' => [
                'ValueList' => ['<string>', ...],
            ],
        ],
    ],
    'EntityTypeSort' => [
        'AmiProductSort' => [
            'SortBy' => 'EntityId|LastModifiedDate|ProductTitle|Visibility',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        'ContainerProductSort' => [
            'SortBy' => 'EntityId|LastModifiedDate|ProductTitle|Visibility',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        'DataProductSort' => [
            'SortBy' => 'EntityId|ProductTitle|Visibility|LastModifiedDate',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        'OfferSort' => [
            'SortBy' => 'EntityId|Name|ProductId|ResaleAuthorizationId|ReleaseDate|AvailabilityEndDate|BuyerAccounts|State|Targeting|LastModifiedDate',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        'ResaleAuthorizationSort' => [
            'SortBy' => 'EntityId|Name|ProductId|ProductName|ManufacturerAccountId|ManufacturerLegalName|ResellerAccountID|ResellerLegalName|Status|OfferExtendedStatus|CreatedDate|AvailabilityEndDate|LastModifiedDate',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
        'SaaSProductSort' => [
            'SortBy' => 'EntityId|ProductTitle|Visibility|LastModifiedDate',
            'SortOrder' => 'ASCENDING|DESCENDING',
        ],
    ],
    'FilterList' => [
        [
            'Name' => '<string>',
            'ValueList' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OwnershipType' => 'SELF|SHARED',
    'Sort' => [
        'SortBy' => '<string>',
        'SortOrder' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

The catalog related to the request. Fixed value: AWSMarketplace

EntityType

: Required: Yes
: Type: string

The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

EntityTypeFilters

: Type: EntityTypeFilters structure

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

EntityTypeSort

: Type: EntityTypeSort structure

A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

FilterList

: Type: Array of Filter structures

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

MaxResults

: Type: int

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

NextToken

: Type: string

The value of the next token, if it exists. Null if there are no more results.

OwnershipType

: Type: string

Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

Sort

: Type: Sort structure

An object that contains two attributes, SortBy and SortOrder.

Result Syntax

[
    'EntitySummaryList' => [
        [
            'AmiProductSummary' => [
                'ProductTitle' => '<string>',
                'Visibility' => 'Limited|Public|Restricted|Draft',
            ],
            'ContainerProductSummary' => [
                'ProductTitle' => '<string>',
                'Visibility' => 'Limited|Public|Restricted|Draft',
            ],
            'DataProductSummary' => [
                'ProductTitle' => '<string>',
                'Visibility' => 'Limited|Public|Restricted|Unavailable|Draft',
            ],
            'EntityArn' => '<string>',
            'EntityId' => '<string>',
            'EntityType' => '<string>',
            'LastModifiedDate' => '<string>',
            'Name' => '<string>',
            'OfferSummary' => [
                'AvailabilityEndDate' => '<string>',
                'BuyerAccounts' => ['<string>', ...],
                'Name' => '<string>',
                'ProductId' => '<string>',
                'ReleaseDate' => '<string>',
                'ResaleAuthorizationId' => '<string>',
                'State' => 'Draft|Released',
                'Targeting' => ['<string>', ...],
            ],
            'ResaleAuthorizationSummary' => [
                'AvailabilityEndDate' => '<string>',
                'CreatedDate' => '<string>',
                'ManufacturerAccountId' => '<string>',
                'ManufacturerLegalName' => '<string>',
                'Name' => '<string>',
                'OfferExtendedStatus' => '<string>',
                'ProductId' => '<string>',
                'ProductName' => '<string>',
                'ResellerAccountID' => '<string>',
                'ResellerLegalName' => '<string>',
                'Status' => 'Draft|Active|Restricted',
            ],
            'SaaSProductSummary' => [
                'ProductTitle' => '<string>',
                'Visibility' => 'Limited|Public|Restricted|Draft',
            ],
            'Visibility' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EntitySummaryList

: Type: Array of EntitySummary structures

Array of EntitySummary objects.

NextToken

: Type: string

The value of the next token if it exists. Null if there is no more result.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags that have been added to a resource (either an entity or change set).

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

Result Syntax

[
    'ResourceArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ResourceArn

: Type: string

Required. The ARN associated with the resource you want to list tags on.

Tags

: Type: Array of Tag structures

Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

Errors

The specified resource wasn't found.

HTTP status code: 404

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

Too many requests.

HTTP status code: 429

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Policy

: Required: Yes
: Type: string

The policy document to set; formatted in JSON.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

The specified resource wasn't found.

HTTP status code: 404

Too many requests.

HTTP status code: 429

StartChangeSet

$result = $client->startChangeSet([/* ... */]);
$promise = $client->startChangeSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startChangeSet([
    'Catalog' => '<string>', // REQUIRED
    'ChangeSet' => [ // REQUIRED
        [
            'ChangeName' => '<string>',
            'ChangeType' => '<string>', // REQUIRED
            'Details' => '<string>',
            'DetailsDocument' => [
            ],
            'Entity' => [ // REQUIRED
                'Identifier' => '<string>',
                'Type' => '<string>', // REQUIRED
            ],
            'EntityTags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ChangeSetName' => '<string>',
    'ChangeSetTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ClientRequestToken' => '<string>',
    'Intent' => 'VALIDATE|APPLY',
]);

Parameter Details

Members

Catalog

: Required: Yes
: Type: string

The catalog related to the request. Fixed value: AWSMarketplace

ChangeSet

: Required: Yes
: Type: Array of Change structures

Array of change object.

ChangeSetName

: Type: 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.

ChangeSetTags

: Type: Array of Tag structures

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

ClientRequestToken

: Type: string

A unique token to identify the request to ensure idempotency.

Intent

: Type: 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.

Result Syntax

[
    'ChangeSetArn' => '<string>',
    'ChangeSetId' => '<string>',
]

Result Details

Members

ChangeSetArn

: Type: string

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

ChangeSetId

: Type: string

Unique identifier generated for the request.

Errors

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

ResourceInUseException:

The specified resource wasn't found.

HTTP status code: 404

The resource is currently in use.

ServiceQuotaExceededException:

Too many requests.

HTTP status code: 429

The maximum number of open requests per account has been exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a resource (either an entity or change set).

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.

Tags

: Required: Yes
: Type: Array of Tag structures

Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The specified resource wasn't found.

HTTP status code: 404

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422

Too many requests.

HTTP status code: 429

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or list of tags from a resource (either an entity or change set).

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

TagKeys

: Required: Yes
: Type: Array of strings

Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The specified resource wasn't found.

HTTP status code: 404

There was an internal service exception.

HTTP status code: 500

Access is denied.

HTTP status code: 403

An error occurred during validation.

HTTP status code: 422