AWS Marketplace Catalog Service 2018-09-17
- Client: Aws\MarketplaceCatalog\MarketplaceCatalogClient
- Service ID: marketplace-catalog
- Version: 2018-09-17
This page describes the parameters and results for the operations of the AWS Marketplace Catalog Service (2018-09-17), and shows how to use the Aws\MarketplaceCatalog\MarketplaceCatalogClient object to call the described operations. This documentation is specific to the 2018-09-17 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CancelChangeSet ( array $params = [] )
Used to cancel an open change request.
- DescribeChangeSet ( array $params = [] )
Provides information about a given change set.
- DescribeEntity ( array $params = [] )
Returns the metadata and content of the entity.
- ListChangeSets ( array $params = [] )
Returns the list of change sets owned by the account being used to make the call.
- ListEntities ( array $params = [] )
Provides the list of entities of a given type.
- StartChangeSet ( array $params = [] )
This operation allows you to request changes for your entities.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
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
Result Syntax
[
'ChangeSetArn' => '<string>',
'ChangeSetId' => '<string>',
]
Result Details
Members
Errors
-
There was an internal service exception.
-
Access is denied.
-
An error occurred during validation.
-
The specified resource wasn't found.
-
The resource is currently in use.
-
Too many requests.
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
Result Syntax
[
'ChangeSet' => [
[
'ChangeName' => '<string>',
'ChangeType' => '<string>',
'Details' => '<string>',
'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>',
'StartTime' => '<string>',
'Status' => 'PREPARING|APPLYING|SUCCEEDED|CANCELLED|FAILED',
]
Result Details
Members
- ChangeSet
-
- Type: Array of ChangeSummary structures
An array of
ChangeSummaryobjects. - 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
StartChangeSetrequest. 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
FAILEDstatus. Can be eitherCLIENT_ERROR, which means that there are issues with the request (see theErrorDetailList), orSERVER_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.
- 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.
-
Access is denied.
-
An error occurred during validation.
-
The specified resource wasn't found.
-
Too many requests.
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
Result Syntax
[
'Details' => '<string>',
'EntityArn' => '<string>',
'EntityIdentifier' => '<string>',
'EntityType' => '<string>',
'LastModifiedDate' => '<string>',
]
Result Details
Members
- Details
-
- Type: string
This stringified JSON object includes the details of the entity.
- EntityArn
-
- Type: string
The ARN associated to the unique identifier for the change set 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.
-
Access is denied.
-
An error occurred during validation.
-
ResourceNotSupportedException:
Currently, the specified resource is not supported.
-
The specified resource wasn't found.
-
Too many requests.
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,
SortByandSortOrder.
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
ChangeSetSummaryListItemobjects. - 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.
-
Access is denied.
-
An error occurred during validation.
-
Too many requests.
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
'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 - EntityType
-
- Required: Yes
- Type: string
The type of entities to retrieve.
- FilterList
-
- Type: Array of Filter structures
An array of filter objects. Each filter object contains two attributes,
filterNameandfilterValues. - 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.
- Sort
-
- Type: Sort structure
An object that contains two attributes,
SortByandSortOrder.
Result Syntax
[
'EntitySummaryList' => [
[
'EntityArn' => '<string>',
'EntityId' => '<string>',
'EntityType' => '<string>',
'LastModifiedDate' => '<string>',
'Name' => '<string>',
'Visibility' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- EntitySummaryList
-
- Type: Array of EntitySummary structures
Array of
EntitySummaryobject. - 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.
-
Access is denied.
-
An error occurred during validation.
-
The specified resource wasn't found.
-
Too many requests.
StartChangeSet
$result = $client->startChangeSet([/* ... */]); $promise = $client->startChangeSetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->startChangeSet([
'Catalog' => '<string>', // REQUIRED
'ChangeSet' => [ // REQUIRED
[
'ChangeName' => '<string>',
'ChangeType' => '<string>', // REQUIRED
'Details' => '<string>', // REQUIRED
'Entity' => [ // REQUIRED
'Identifier' => '<string>',
'Type' => '<string>', // REQUIRED
],
],
// ...
],
'ChangeSetName' => '<string>',
'ClientRequestToken' => '<string>',
]);
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
changeobject. - 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.
- ClientRequestToken
-
- Type: string
A unique token to identify the request to ensure idempotency.
Result Syntax
[
'ChangeSetArn' => '<string>',
'ChangeSetId' => '<string>',
]
Result Details
Members
Errors
-
There was an internal service exception.
-
Access is denied.
-
An error occurred during validation.
-
The specified resource wasn't found.
-
The resource is currently in use.
-
Too many requests.
-
ServiceQuotaExceededException:
The maximum number of open requests per account has been exceeded.
Shapes
AccessDeniedException
Change
Description
An object that contains the ChangeType, Details, and Entity.
Members
- ChangeName
-
- Type: string
Optional name for the change.
- ChangeType
-
- Required: Yes
- Type: string
Change types are single string values that describe your intention for the change. Each change type is unique for each
EntityTypeprovided in the change's scope. - Details
-
- Required: Yes
- Type: string
This object contains details specific to the change type of the requested change.
- Entity
-
- Required: Yes
- Type: Entity structure
The entity to be changed.
ChangeSetSummaryListItem
Description
A summary of a change set returned in a list of change sets when the ListChangeSets action is called.
Members
- ChangeSetArn
-
- Type: string
The ARN associated with the unique identifier for the change set referenced in this request.
- ChangeSetId
-
- Type: string
The unique identifier for a change set.
- ChangeSetName
-
- Type: string
The non-unique name for the change set.
- EndTime
-
- Type: string
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
- EntityIdList
-
- Type: Array of strings
This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of 20 entities. It must contain at least one entity.
- FailureCode
-
- Type: string
Returned if the change set is in
FAILEDstatus. Can be eitherCLIENT_ERROR, which means that there are issues with the request (see theErrorDetailListofDescribeChangeSet), orSERVER_FAULT, which means that there is a problem in the system, and you should retry your request. - StartTime
-
- Type: string
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
- Status
-
- Type: string
The current status of the change set.
ChangeSummary
Description
This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
Members
- ChangeName
-
- Type: string
Optional name for the change.
- ChangeType
-
- Type: string
The type of the change.
- Details
-
- Type: string
This object contains details specific to the change type of the requested change.
- Entity
-
- Type: Entity structure
The entity to be changed.
- ErrorDetailList
-
- Type: Array of ErrorDetail structures
An array of
ErrorDetailobjects associated with the change.
Entity
Description
An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.
Members
EntitySummary
Description
This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.
Members
- EntityArn
-
- Type: string
The ARN associated with the unique identifier for the entity.
- EntityId
-
- Type: string
The unique identifier for the entity.
- EntityType
-
- Type: string
The type of the entity.
- LastModifiedDate
-
- Type: string
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
- Name
-
- Type: string
The name for the entity. This value is not unique. It is defined by the seller.
- Visibility
-
- Type: string
The visibility status of the entity to buyers. This value can be
Public(everyone can view the entity),Limited(the entity is visible to limited accounts only), orRestricted(the entity was published and then unpublished and only existing buyers can view it).
ErrorDetail
Description
Details about the error.
Members
Filter
Description
A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.
Members
- Name
-
- Type: string
For
ListEntities, the supported value for this is anEntityId.For
ListChangeSets, the supported values are as follows: - ValueList
-
- Type: Array of strings
ListEntities- This is a list of uniqueEntityIds.ListChangeSets- The supported filter names and associatedValueLists is as follows:-
ChangeSetName- The supportedValueListis a list of non-uniqueChangeSetNames. These are defined when you call theStartChangeSetaction. -
Status- The supportedValueListis a list of statuses for all change set requests. -
EntityId- The supportedValueListis a list of uniqueEntityIds. -
BeforeStartTime- The supportedValueListis a list of all change sets that started before the filter value. -
AfterStartTime- The supportedValueListis a list of all change sets that started after the filter value. -
BeforeEndTime- The supportedValueListis a list of all change sets that ended before the filter value. -
AfterEndTime- The supportedValueListis a list of all change sets that ended after the filter value.
InternalServiceException
ResourceInUseException
ResourceNotFoundException
ResourceNotSupportedException
ServiceQuotaExceededException
Description
The maximum number of open requests per account has been exceeded.
Members
Sort
Description
An object that contains two attributes, SortBy and SortOrder.
Members
- SortBy
-
- Type: string
For
ListEntities, supported attributes includeLastModifiedDate(default),Visibility,EntityId, andName.For
ListChangeSets, supported attributes includeStartTimeandEndTime. - SortOrder
-
- Type: string
The sorting order. Can be
ASCENDINGorDESCENDING. The default value isDESCENDING.