/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::MarketplaceCatalog

NAME

Paws::MarketplaceCatalog - Perl Interface to AWS AWS Marketplace Catalog Service

SYNOPSIS

use Paws;

my $obj = Paws->service('MarketplaceCatalog');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.

You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/catalog.marketplace-2018-09-17

METHODS

CancelChangeSet

Catalog => Str
ChangeSetId => Str

Each argument is described in detail in: Paws::MarketplaceCatalog::CancelChangeSet

Returns: a Paws::MarketplaceCatalog::CancelChangeSetResponse instance

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.

DescribeChangeSet

Catalog => Str
ChangeSetId => Str

Each argument is described in detail in: Paws::MarketplaceCatalog::DescribeChangeSet

Returns: a Paws::MarketplaceCatalog::DescribeChangeSetResponse instance

Provides information about a given change set.

DescribeEntity

Catalog => Str
EntityId => Str

Each argument is described in detail in: Paws::MarketplaceCatalog::DescribeEntity

Returns: a Paws::MarketplaceCatalog::DescribeEntityResponse instance

Returns the metadata and content of the entity.

ListChangeSets

Catalog => Str
[FilterList => ArrayRef[Paws::MarketplaceCatalog::Filter]]
[MaxResults => Int]
[NextToken => Str]
[Sort => Paws::MarketplaceCatalog::Sort]

Each argument is described in detail in: Paws::MarketplaceCatalog::ListChangeSets

Returns: a Paws::MarketplaceCatalog::ListChangeSetsResponse instance

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.

ListEntities

Catalog => Str
EntityType => Str
[FilterList => ArrayRef[Paws::MarketplaceCatalog::Filter]]
[MaxResults => Int]
[NextToken => Str]
[Sort => Paws::MarketplaceCatalog::Sort]

Each argument is described in detail in: Paws::MarketplaceCatalog::ListEntities

Returns: a Paws::MarketplaceCatalog::ListEntitiesResponse instance

Provides the list of entities of a given type.

StartChangeSet

Catalog => Str
ChangeSet => ArrayRef[Paws::MarketplaceCatalog::Change]
[ChangeSetName => Str]
[ClientRequestToken => Str]

Each argument is described in detail in: Paws::MarketplaceCatalog::StartChangeSet

Returns: a Paws::MarketplaceCatalog::StartChangeSetResponse instance

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 (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples) 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 (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets).

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues