AWS SDK for PHP 3.x

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 */).

BatchDescribeEntities ( array $params = [] ): Returns metadata and content for multiple entities.
CancelChangeSet ( array $params = [] ): Used to cancel an open change request.
DeleteResourcePolicy ( array $params = [] ): Deletes a resource-based policy on an entity that is identified by its resource ARN.
DescribeChangeSet ( array $params = [] ): Provides information about a given change set.
DescribeEntity ( array $params = [] ): Returns the metadata and content of the entity.
GetResourcePolicy ( array $params = [] ): Gets a resource-based policy of an entity that is identified by its resource ARN.
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.
ListTagsForResource ( array $params = [] ): Lists all tags that have been added to a resource (either an entity or change set).
PutResourcePolicy ( array $params = [] ): Attaches a resource-based policy to an entity.
StartChangeSet ( array $params = [] ): Allows you to request changes for your entities.
TagResource ( array $params = [] ): Tags a resource (either an entity or change set).
UntagResource ( array $params = [] ): Removes a tag or list of tags from a resource (either an entity or change set).

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:

ListChangeSets
ListEntities

Operations

BatchDescribeEntities

$result = $client->batchDescribeEntities([/* ... */]);
$promise = $client->batchDescribeEntitiesAsync([/* ... */]);

Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.

Parameter Syntax

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

Parameter Details

Members

EntityRequestList

Required: Yes
Type: Array of EntityRequest structures

List of entity IDs and the catalogs the entities are present in.

Result Syntax

[
    'EntityDetails' => [
        '<EntityId>' => [
            'DetailsDocument' => [
            ],
            'EntityArn' => '<string>',
            'EntityIdentifier' => '<string>',
            'EntityType' => '<string>',
            'LastModifiedDate' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        '<EntityId>' => [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

EntityDetails

Type: Associative array of custom strings keys (EntityId) to EntityDetail structures

Details about each entity.

Errors

Type: Associative array of custom strings keys (EntityId) to BatchDescribeErrorDetail structures

A map of errors returned, with EntityId as the key and errorDetail as the value.

Errors

AccessDeniedException:
Access is denied.

HTTP status code: 403
InternalServiceException:
There was an internal service exception.

HTTP status code: 500
ThrottlingException:
Too many requests.

HTTP status code: 429
ValidationException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ResourceInUseException:
The resource is currently in use.
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotSupportedException:
Currently, the specified resource is not supported.
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ThrottlingException:
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

InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
ResourceInUseException:
The resource is currently in use.
ThrottlingException:
Too many requests.

HTTP status code: 429
ServiceQuotaExceededException:
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

ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ThrottlingException:
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

ResourceNotFoundException:
The specified resource wasn't found.

HTTP status code: 404
InternalServiceException:
There was an internal service exception.

HTTP status code: 500
AccessDeniedException:
Access is denied.

HTTP status code: 403
ValidationException:
An error occurred during validation.

HTTP status code: 422
ThrottlingException:
Too many requests.

HTTP status code: 429

Shapes

AccessDeniedException

Description

Access is denied.

HTTP status code: 403

Members

Message

Type: string

AmiProductEntityIdFilter

Description

Object that allows filtering on entity id of an AMI product.

Members

ValueList

Type: Array of strings

A string array of unique entity id values to be filtered on.

AmiProductFilters

Description

Object containing all the filter fields for AMI products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

EntityId

Type: AmiProductEntityIdFilter structure

Unique identifier for the AMI product.

LastModifiedDate

Type: AmiProductLastModifiedDateFilter structure

The last date on which the AMI product was modified.

ProductTitle

Type: AmiProductTitleFilter structure

The title of the AMI product.

Visibility

Type: AmiProductVisibilityFilter structure

The visibility of the AMI product.

AmiProductLastModifiedDateFilter

Description

Object that allows filtering based on the last modified date of AMI products.

Members

DateRange

Type: AmiProductLastModifiedDateFilterDateRange structure

Dates between which the AMI product was last modified.

AmiProductLastModifiedDateFilterDateRange

Description

Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.

Members

AfterValue

Type: string

Date after which the AMI product was last modified.

BeforeValue

Type: string

Date before which the AMI product was last modified.

AmiProductSort

Description

Objects that allows sorting on AMI products based on certain fields and sorting order.

Members

SortBy

Type: string

Field to sort the AMI products by.

SortOrder

Type: string

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

AmiProductSummary

Description

Object that contains summarized information about an AMI product.

Members

ProductTitle

Type: string

The title of the AMI product.

Visibility

Type: string

The lifecycle of the AMI product.

AmiProductTitleFilter

Description

Object that allows filtering on product title.

Members

ValueList

Type: Array of strings

A string array of unique product title values to be filtered on.

WildCardValue

Type: string

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

AmiProductVisibilityFilter

Description

Object that allows filtering on the visibility of the product in the AWS Marketplace.

Members

ValueList

Type: Array of strings

A string array of unique visibility values to be filtered on.

BatchDescribeErrorDetail

Description

An object that contains an error code and error message.

Members

ErrorCode

Type: string

The error code returned.

ErrorMessage

Type: string

The error message returned.

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 EntityType provided in the change's scope. For more information about change types available 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.

Details

Type: string

This object contains details specific to the change type of the requested change. For more information about change types available 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.

DetailsDocument

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

Alternative field that accepts a JSON value instead of a string for ChangeType details. You can use either Details or DetailsDocument, but not both.

Entity

Required: Yes
Type: Entity structure

The entity to be changed.

EntityTags

Type: Array of Tag structures

The tags associated with the change.

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 FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList of DescribeChangeSet), or SERVER_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.

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 change type of the requested change.

Entity

Type: Entity structure

The entity to be changed.

ErrorDetailList

Type: Array of ErrorDetail structures

An array of ErrorDetail objects associated with the change.

ContainerProductEntityIdFilter

Description

Object that allows filtering on entity id of a container product.

Members

ValueList

Type: Array of strings

A string array of unique entity id values to be filtered on.

ContainerProductFilters

Description

Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

EntityId

Type: ContainerProductEntityIdFilter structure

Unique identifier for the container product.

LastModifiedDate

Type: ContainerProductLastModifiedDateFilter structure

The last date on which the container product was modified.

ProductTitle

Type: ContainerProductTitleFilter structure

The title of the container product.

Visibility

Type: ContainerProductVisibilityFilter structure

The visibility of the container product.

ContainerProductLastModifiedDateFilter

Description

Object that allows filtering based on the last modified date of container products.

Members

DateRange

Type: ContainerProductLastModifiedDateFilterDateRange structure

Dates between which the container product was last modified.

ContainerProductLastModifiedDateFilterDateRange

Description

Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.

Members

AfterValue

Type: string

Date after which the container product was last modified.

BeforeValue

Type: string

Date before which the container product was last modified.

ContainerProductSort

Description

Objects that allows sorting on container products based on certain fields and sorting order.

Members

SortBy

Type: string

Field to sort the container products by.

SortOrder

Type: string

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

ContainerProductSummary

Description

Object that contains summarized information about a container product.

Members

ProductTitle

Type: string

The title of the container product.

Visibility

Type: string

The lifecycle of the product.

ContainerProductTitleFilter

Description

Object that allows filtering on product title.

Members

ValueList

Type: Array of strings

A string array of unique product title values to be filtered on.

WildCardValue

Type: string

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

ContainerProductVisibilityFilter

Description

Object that allows filtering on the visibility of the product in the AWS Marketplace.

Members

ValueList

Type: Array of strings

A string array of unique visibility values to be filtered on.

DataProductEntityIdFilter

Description

Object that allows filtering on entity id of a data product.

Members

ValueList

Type: Array of strings

A string array of unique entity id values to be filtered on.

DataProductFilters

Description

Object containing all the filter fields for data products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

EntityId

Type: DataProductEntityIdFilter structure

Unique identifier for the data product.

LastModifiedDate

Type: DataProductLastModifiedDateFilter structure

The last date on which the data product was modified.

ProductTitle

Type: DataProductTitleFilter structure

The title of the data product.

Visibility

Type: DataProductVisibilityFilter structure

The visibility of the data product.

DataProductLastModifiedDateFilter

Description

Object that allows filtering based on the last modified date of data products.

Members

DateRange

Type: DataProductLastModifiedDateFilterDateRange structure

Dates between which the data product was last modified.

DataProductLastModifiedDateFilterDateRange

Description

Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.

Members

AfterValue

Type: string

Date after which the data product was last modified.

BeforeValue

Type: string

Date before which the data product was last modified.

DataProductSort

Description

Objects that allows sorting on data products based on certain fields and sorting order.

Members

SortBy

Type: string

Field to sort the data products by.

SortOrder

Type: string

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

DataProductSummary

Description

Object that contains summarized information about a data product.

Members

ProductTitle

Type: string

The title of the data product.

Visibility

Type: string

The lifecycle of the data product.

DataProductTitleFilter

Description

Object that allows filtering on product title.

Members

ValueList

Type: Array of strings

A string array of unique product title values to be filtered on.

WildCardValue

Type: string

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

DataProductVisibilityFilter

Description

Object that allows filtering on the visibility of the product in the AWS Marketplace.

Members

ValueList

Type: Array of strings

A string array of unique visibility values to be filtered on.

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

Identifier

Type: string

The identifier for the entity.

Type

Required: Yes
Type: string

The type of entity.

EntityDetail

Description

An object that contains metadata and details about the entity.

Members

DetailsDocument

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

An object that contains all the details of the entity.

EntityArn

Type: string

The Amazon Resource Name (ARN) of the entity.

EntityIdentifier

Type: string

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

EntityType

Type: string

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

LastModifiedDate

Type: string

The last time the entity was modified.

EntityRequest

Description

An object that contains entity ID and the catalog in which the entity is present.

Members

Catalog

Required: Yes
Type: string

The name of the catalog the entity is present in. The only value at this time is AWSMarketplace.

EntityId

Required: Yes
Type: string

The ID of the entity.

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

AmiProductSummary

Type: AmiProductSummary structure

An object that contains summary information about the AMI product.

ContainerProductSummary

Type: ContainerProductSummary structure

An object that contains summary information about the container product.

DataProductSummary

Type: DataProductSummary structure

An object that contains summary information about the data product.

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.

OfferSummary

Type: OfferSummary structure

An object that contains summary information about the offer.

ResaleAuthorizationSummary

Type: ResaleAuthorizationSummary structure

An object that contains summary information about the Resale Authorization.

SaaSProductSummary

Type: SaaSProductSummary structure

An object that contains summary information about the SaaS product.

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), or Restricted (the entity was published and then unpublished and only existing buyers can view it).

EntityTypeFilters

Description

Object containing all the filter fields per entity type.

Members

AmiProductFilters

Type: AmiProductFilters structure

A filter for AMI products.

ContainerProductFilters

Type: ContainerProductFilters structure

A filter for container products.

DataProductFilters

Type: DataProductFilters structure

A filter for data products.

OfferFilters

Type: OfferFilters structure

A filter for offers.

ResaleAuthorizationFilters

Type: ResaleAuthorizationFilters structure

A filter for Resale Authorizations.

SaaSProductFilters

Type: SaaSProductFilters structure

A filter for SaaS products.

EntityTypeSort

Description

Object containing all the sort fields per entity type.

Members

AmiProductSort

Type: AmiProductSort structure

A sort for AMI products.

ContainerProductSort

Type: ContainerProductSort structure

A sort for container products.

DataProductSort

Type: DataProductSort structure

A sort for data products.

OfferSort

Type: OfferSort structure

A sort for offers.

ResaleAuthorizationSort

Type: ResaleAuthorizationSort structure

A sort for Resale Authorizations.

SaaSProductSort

Type: SaaSProductSort structure

A sort for SaaS products.

ErrorDetail

Description

Details about the error.

Members

ErrorCode

Type: string

The error code that identifies the type of error.

ErrorMessage

Type: string

The message for the error.

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 an EntityId.

For ListChangeSets, the supported values are as follows:

ValueList

Type: Array of strings

ListEntities - This is a list of unique EntityIds.

ListChangeSets - The supported filter names and associated ValueLists is as follows:

ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.
Status - The supported ValueList is a list of statuses for all change set requests.
EntityId - The supported ValueList is a list of unique EntityIds.
BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.
AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.
BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.
AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.

InternalServiceException

Description

There was an internal service exception.

HTTP status code: 500

Members

Message

Type: string

JsonDocumentType

Members

OfferAvailabilityEndDateFilter

Description

Allows filtering on the AvailabilityEndDate of an offer.

Members

DateRange

Type: OfferAvailabilityEndDateFilterDateRange structure

Allows filtering on the AvailabilityEndDate of an offer with date range as input.

OfferAvailabilityEndDateFilterDateRange

Description

Allows filtering on the AvailabilityEndDate of an offer with date range as input.

Members

AfterValue

Type: string

Allows filtering on the AvailabilityEndDate of an offer after a date.

BeforeValue

Type: string

Allows filtering on the AvailabilityEndDate of an offer before a date.

OfferBuyerAccountsFilter

Description

Allows filtering on the BuyerAccounts of an offer.

Members

WildCardValue

Type: string

Allows filtering on the BuyerAccounts of an offer with wild card input.

OfferEntityIdFilter

Description

Allows filtering on the entity id of an offer.

Members

ValueList

Type: Array of strings

Allows filtering on entity id of an offer with list input.

OfferFilters

Description

Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

AvailabilityEndDate

Type: OfferAvailabilityEndDateFilter structure

Allows filtering on the AvailabilityEndDate of an offer.

BuyerAccounts

Type: OfferBuyerAccountsFilter structure

Allows filtering on the BuyerAccounts of an offer.

EntityId

Type: OfferEntityIdFilter structure

Allows filtering on EntityId of an offer.

LastModifiedDate

Type: OfferLastModifiedDateFilter structure

Allows filtering on the LastModifiedDate of an offer.

Name

Type: OfferNameFilter structure

Allows filtering on the Name of an offer.

ProductId

Type: OfferProductIdFilter structure

Allows filtering on the ProductId of an offer.

ReleaseDate

Type: OfferReleaseDateFilter structure

Allows filtering on the ReleaseDate of an offer.

ResaleAuthorizationId

Type: OfferResaleAuthorizationIdFilter structure

Allows filtering on the ResaleAuthorizationId of an offer.

Not all offers have a ResaleAuthorizationId. The response will only include offers for which you have permissions.

State

Type: OfferStateFilter structure

Allows filtering on the State of an offer.

Targeting

Type: OfferTargetingFilter structure

Allows filtering on the Targeting of an offer.

OfferLastModifiedDateFilter

Description

Allows filtering on the LastModifiedDate of an offer.

Members

DateRange

Type: OfferLastModifiedDateFilterDateRange structure

Allows filtering on the LastModifiedDate of an offer with date range as input.

OfferLastModifiedDateFilterDateRange

Description

Allows filtering on the LastModifiedDate of an offer with date range as input.

Members

AfterValue

Type: string

Allows filtering on the LastModifiedDate of an offer after a date.

BeforeValue

Type: string

Allows filtering on the LastModifiedDate of an offer before a date.

OfferNameFilter

Description

Allows filtering on the Name of an offer.

Members

ValueList

Type: Array of strings

Allows filtering on the Name of an offer with list input.

WildCardValue

Type: string

Allows filtering on the Name of an offer with wild card input.

OfferProductIdFilter

Description

Allows filtering on the ProductId of an offer.

Members

ValueList

Type: Array of strings

Allows filtering on the ProductId of an offer with list input.

OfferReleaseDateFilter

Description

Allows filtering on the ReleaseDate of an offer.

Members

DateRange

Type: OfferReleaseDateFilterDateRange structure

Allows filtering on the ReleaseDate of an offer with date range as input.

OfferReleaseDateFilterDateRange

Description

Allows filtering on the ReleaseDate of an offer with date range as input.

Members

AfterValue

Type: string

Allows filtering on the ReleaseDate of offers after a date.

BeforeValue

Type: string

Allows filtering on the ReleaseDate of offers before a date.

OfferResaleAuthorizationIdFilter

Description

Allows filtering on the ResaleAuthorizationId of an offer.

Not all offers have a ResaleAuthorizationId. The response will only include offers for which you have permissions.

Members

ValueList

Type: Array of strings

Allows filtering on the ResaleAuthorizationId of an offer with list input.

OfferSort

Description

Allows to sort offers.

Members

SortBy

Type: string

Allows to sort offers.

SortOrder

Type: string

Allows to sort offers.

OfferStateFilter

Description

Allows filtering on the State of an offer.

Members

ValueList

Type: Array of strings

Allows filtering on the State of an offer with list input.

OfferSummary

Description

Summarized information about an offer.

Members

AvailabilityEndDate

Type: string

The availability end date of the offer.

BuyerAccounts

Type: Array of strings

The buyer accounts in the offer.

Name

Type: string

The name of the offer.

ProductId

Type: string

The product ID of the offer.

ReleaseDate

Type: string

The release date of the offer.

ResaleAuthorizationId

Type: string

The ResaleAuthorizationId of the offer.

State

Type: string

The status of the offer.

Targeting

Type: Array of strings

The targeting in the offer.

OfferTargetingFilter

Description

Allows filtering on the Targeting of an offer.

Members

ValueList

Type: Array of strings

Allows filtering on the Targeting of an offer with list input.

ResaleAuthorizationAvailabilityEndDateFilter

Description

Allows filtering on AvailabilityEndDate of a ResaleAuthorization.

Members

DateRange

Type: ResaleAuthorizationAvailabilityEndDateFilterDateRange structure

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input

ValueList

Type: Array of strings

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date value as input.

ResaleAuthorizationAvailabilityEndDateFilterDateRange

Description

Allows filtering on AvailabilityEndDate of a ResaleAuthorization with date range as input.

Members

AfterValue

Type: string

Allows filtering on AvailabilityEndDate of a ResaleAuthorization after a date.

BeforeValue

Type: string

Allows filtering on AvailabilityEndDate of a ResaleAuthorization before a date.

ResaleAuthorizationCreatedDateFilter

Description

Allows filtering on CreatedDate of a ResaleAuthorization.

Members

DateRange

Type: ResaleAuthorizationCreatedDateFilterDateRange structure

Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.

ValueList

Type: Array of strings

Allows filtering on CreatedDate of a ResaleAuthorization with date value as input.

ResaleAuthorizationCreatedDateFilterDateRange

Description

Allows filtering on CreatedDate of a ResaleAuthorization with date range as input.

Members

AfterValue

Type: string

Allows filtering on CreatedDate of a ResaleAuthorization after a date.

BeforeValue

Type: string

Allows filtering on CreatedDate of a ResaleAuthorization before a date.

ResaleAuthorizationEntityIdFilter

Description

Allows filtering on EntityId of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on EntityId of a ResaleAuthorization with list input.

ResaleAuthorizationFilters

Description

Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

AvailabilityEndDate

Type: ResaleAuthorizationAvailabilityEndDateFilter structure

Allows filtering on the AvailabilityEndDate of a ResaleAuthorization.

CreatedDate

Type: ResaleAuthorizationCreatedDateFilter structure

Allows filtering on the CreatedDate of a ResaleAuthorization.

EntityId

Type: ResaleAuthorizationEntityIdFilter structure

Allows filtering on the EntityId of a ResaleAuthorization.

LastModifiedDate

Type: ResaleAuthorizationLastModifiedDateFilter structure

Allows filtering on the LastModifiedDate of a ResaleAuthorization.

ManufacturerAccountId

Type: ResaleAuthorizationManufacturerAccountIdFilter structure

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.

ManufacturerLegalName

Type: ResaleAuthorizationManufacturerLegalNameFilter structure

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.

Name

Type: ResaleAuthorizationNameFilter structure

Allows filtering on the Name of a ResaleAuthorization.

OfferExtendedStatus

Type: ResaleAuthorizationOfferExtendedStatusFilter structure

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.

ProductId

Type: ResaleAuthorizationProductIdFilter structure

Allows filtering on the ProductId of a ResaleAuthorization.

ProductName

Type: ResaleAuthorizationProductNameFilter structure

Allows filtering on the ProductName of a ResaleAuthorization.

ResellerAccountID

Type: ResaleAuthorizationResellerAccountIDFilter structure

Allows filtering on the ResellerAccountID of a ResaleAuthorization.

ResellerLegalName

Type: ResaleAuthorizationResellerLegalNameFilter structure

Allows filtering on the ResellerLegalName of a ResaleAuthorization.

Status

Type: ResaleAuthorizationStatusFilter structure

Allows filtering on the Status of a ResaleAuthorization.

ResaleAuthorizationLastModifiedDateFilter

Description

Allows filtering on the LastModifiedDate of a ResaleAuthorization.

Members

DateRange

Type: ResaleAuthorizationLastModifiedDateFilterDateRange structure

Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.

ResaleAuthorizationLastModifiedDateFilterDateRange

Description

Allows filtering on the LastModifiedDate of a ResaleAuthorization with date range as input.

Members

AfterValue

Type: string

Allows filtering on the LastModifiedDate of a ResaleAuthorization after a date.

BeforeValue

Type: string

Allows filtering on the LastModifiedDate of a ResaleAuthorization before a date.

ResaleAuthorizationManufacturerAccountIdFilter

Description

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ManufacturerAccountId of a ResaleAuthorization with wild card input.

ResaleAuthorizationManufacturerLegalNameFilter

Description

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ManufacturerLegalName of a ResaleAuthorization with wild card input.

ResaleAuthorizationNameFilter

Description

Allows filtering on the Name of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the Name of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the Name of a ResaleAuthorization with wild card input.

ResaleAuthorizationOfferExtendedStatusFilter

Description

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the OfferExtendedStatus of a ResaleAuthorization with list input.

ResaleAuthorizationProductIdFilter

Description

Allows filtering on the ProductId of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ProductId of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ProductId of a ResaleAuthorization with wild card input.

ResaleAuthorizationProductNameFilter

Description

Allows filtering on the ProductName of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ProductName of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ProductName of a ResaleAuthorization with wild card input.

ResaleAuthorizationResellerAccountIDFilter

Description

Allows filtering on the ResellerAccountID of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ResellerAccountID of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ResellerAccountID of a ResaleAuthorization with wild card input.

ResaleAuthorizationResellerLegalNameFilter

Description

Allows filtering on the ResellerLegalName of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the ResellerLegalNameProductName of a ResaleAuthorization with list input.

WildCardValue

Type: string

Allows filtering on the ResellerLegalName of a ResaleAuthorization with wild card input.

ResaleAuthorizationSort

Description

Allows to sort ResaleAuthorization.

Members

SortBy

Type: string

Allows to sort ResaleAuthorization.

SortOrder

Type: string

Allows to sort ResaleAuthorization.

ResaleAuthorizationStatusFilter

Description

Allows filtering on the Status of a ResaleAuthorization.

Members

ValueList

Type: Array of strings

Allows filtering on the Status of a ResaleAuthorization with list input.

ResaleAuthorizationSummary

Description

Summarized information about a Resale Authorization.

Members

AvailabilityEndDate

Type: string

The availability end date of the ResaleAuthorization.

CreatedDate

Type: string

The created date of the ResaleAuthorization.

ManufacturerAccountId

Type: string

The manufacturer account ID of the ResaleAuthorization.

ManufacturerLegalName

Type: string

The manufacturer legal name of the ResaleAuthorization.

Name

Type: string

The name of the ResaleAuthorization.

OfferExtendedStatus

Type: string

The offer extended status of the ResaleAuthorization

ProductId

Type: string

The product ID of the ResaleAuthorization.

ProductName

Type: string

The product name of the ResaleAuthorization.

ResellerAccountID

Type: string

The reseller account ID of the ResaleAuthorization.

ResellerLegalName

Type: string

The reseller legal name of the ResaleAuthorization

Status

Type: string

The status of the ResaleAuthorization.

ResourceInUseException

Description

The resource is currently in use.

Members

Message

Type: string

ResourceNotFoundException

Description

The specified resource wasn't found.

HTTP status code: 404

Members

Message

Type: string

ResourceNotSupportedException

Description

Currently, the specified resource is not supported.

Members

Message

Type: string

SaaSProductEntityIdFilter

Description

Object that allows filtering on entity id of a SaaS product.

Members

ValueList

Type: Array of strings

A string array of unique entity id values to be filtered on.

SaaSProductFilters

Description

Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

Members

EntityId

Type: SaaSProductEntityIdFilter structure

Unique identifier for the SaaS product.

LastModifiedDate

Type: SaaSProductLastModifiedDateFilter structure

The last date on which the SaaS product was modified.

ProductTitle

Type: SaaSProductTitleFilter structure

The title of the SaaS product.

Visibility

Type: SaaSProductVisibilityFilter structure

The visibility of the SaaS product.

SaaSProductLastModifiedDateFilter

Description

Object that allows filtering based on the last modified date of SaaS products

Members

DateRange

Type: SaaSProductLastModifiedDateFilterDateRange structure

Dates between which the SaaS product was last modified.

SaaSProductLastModifiedDateFilterDateRange

Description

Object that contains date range of the last modified date to be filtered on. You can optionally provide a BeforeValue and/or AfterValue. Both are inclusive.

Members

AfterValue

Type: string

Date after which the SaaS product was last modified.

BeforeValue

Type: string

Date before which the SaaS product was last modified.

SaaSProductSort

Description

Objects that allows sorting on SaaS products based on certain fields and sorting order.

Members

SortBy

Type: string

Field to sort the SaaS products by.

SortOrder

Type: string

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

SaaSProductSummary

Description

Object that contains summarized information about a SaaS product.

Members

ProductTitle

Type: string

The title of the SaaS product.

Visibility

Type: string

The lifecycle of the SaaS product.

SaaSProductTitleFilter

Description

Object that allows filtering on product title.

Members

ValueList

Type: Array of strings

A string array of unique product title values to be filtered on.

WildCardValue

Type: string

A string that will be the wildCard input for product tile filter. It matches the provided value as a substring in the actual value.

SaaSProductVisibilityFilter

Description

Object that allows filtering on the visibility of the product in the AWS Marketplace.

Members

ValueList

Type: Array of strings

A string array of unique visibility values to be filtered on.

ServiceQuotaExceededException

Description

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

Members

Message

Type: string

Sort

Description

An object that contains two attributes, SortBy and SortOrder.

Members

SortBy

Type: string

For ListEntities, supported attributes include LastModifiedDate (default) and EntityId. In addition to LastModifiedDate and EntityId, each EntityType might support additional fields.

For ListChangeSets, supported attributes include StartTime and EndTime.

SortOrder

Type: string

The sorting order. Can be ASCENDING or DESCENDING. The default value is DESCENDING.

ThrottlingException

Description

Too many requests.

HTTP status code: 429

Members

Message

Type: string

ValidationException

Description

An error occurred during validation.

HTTP status code: 422

Members

Message

Type: string

AWS Marketplace Catalog Service 2018-09-17

Operation Summary

Paginators

Operations

BatchDescribeEntities

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelChangeSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeChangeSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeEntity

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListChangeSets

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListEntities

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

PutResourcePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax