MarketplaceCatalog class
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.
Constructors
- MarketplaceCatalog({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchDescribeEntities(
{required List< EntityRequest> entityRequestList}) → Future<BatchDescribeEntitiesResponse> -
Returns metadata and content for multiple entities. This is the Batch
version of the
DescribeEntityAPI and uses the same IAM permission action asDescribeEntityAPI. -
cancelChangeSet(
{required String catalog, required String changeSetId}) → Future< CancelChangeSetResponse> -
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. -
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
deleteResourcePolicy(
{required String resourceArn}) → Future< void> - Deletes a resource-based policy on an entity that is identified by its resource ARN.
-
describeChangeSet(
{required String catalog, required String changeSetId}) → Future< DescribeChangeSetResponse> - Provides information about a given change set.
-
describeEntity(
{required String catalog, required String entityId}) → Future< DescribeEntityResponse> - Returns the metadata and content of the entity.
-
getResourcePolicy(
{required String resourceArn}) → Future< GetResourcePolicyResponse> - Gets a resource-based policy of an entity that is identified by its resource ARN.
-
listChangeSets(
{required String catalog, List< Filter> ? filterList, int? maxResults, String? nextToken, Sort? sort}) → Future<ListChangeSetsResponse> -
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. -
listEntities(
{required String catalog, required String entityType, EntityTypeFilters? entityTypeFilters, EntityTypeSort? entityTypeSort, List< Filter> ? filterList, int? maxResults, String? nextToken, OwnershipType? ownershipType, Sort? sort}) → Future<ListEntitiesResponse> - Provides the list of entities of a given type.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists all tags that have been added to a resource (either an entity or change set).
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putResourcePolicy(
{required String policy, required String resourceArn}) → Future< void> -
Attaches a resource-based policy to an entity. Examples of an entity
include:
AmiProductandContainerProduct. -
startChangeSet(
{required String catalog, required List< Change> changeSet, String? changeSetName, List<Tag> ? changeSetTags, String? clientRequestToken, Intent? intent}) → Future<StartChangeSetResponse> -
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 aChangeSetis 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 aResourceInUseExceptionerror. -
tagResource(
{required String resourceArn, required List< Tag> tags}) → Future<void> - Tags a resource (either an entity or change set).
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes a tag or list of tags from a resource (either an entity or change set).
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited