AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing MarketplaceCatalog

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.MarketplaceCatalog.AmazonMarketplaceCatalogClient

Namespace: Amazon.MarketplaceCatalog
Assembly: AWSSDK.MarketplaceCatalog.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonMarketplaceCatalogClient : AmazonServiceClient
         IAmazonMarketplaceCatalog, IAmazonService, IDisposable

The AmazonMarketplaceCatalogClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMarketplaceCatalogClient()

Constructs AmazonMarketplaceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMarketplaceCatalogClient(RegionEndpoint)

Constructs AmazonMarketplaceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMarketplaceCatalogClient(AmazonMarketplaceCatalogConfig)

Constructs AmazonMarketplaceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMarketplaceCatalogClient(AWSCredentials)

Constructs AmazonMarketplaceCatalogClient with AWS Credentials

Public Method AmazonMarketplaceCatalogClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMarketplaceCatalogClient with AWS Credentials

Public Method AmazonMarketplaceCatalogClient(AWSCredentials, AmazonMarketplaceCatalogConfig)

Constructs AmazonMarketplaceCatalogClient with AWS Credentials and an AmazonMarketplaceCatalogClient Configuration object.

Public Method AmazonMarketplaceCatalogClient(string, string)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMarketplaceCatalogClient(string, string, RegionEndpoint)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMarketplaceCatalogClient(string, string, AmazonMarketplaceCatalogConfig)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonMarketplaceCatalogClient Configuration object.

Public Method AmazonMarketplaceCatalogClient(string, string, string)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMarketplaceCatalogClient(string, string, string, RegionEndpoint)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMarketplaceCatalogClient(string, string, string, AmazonMarketplaceCatalogConfig)

Constructs AmazonMarketplaceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonMarketplaceCatalogClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.MarketplaceCatalog.Model.IMarketplaceCatalogPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchDescribeEntities(BatchDescribeEntitiesRequest)

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.

Public Method BatchDescribeEntitiesAsync(BatchDescribeEntitiesRequest, CancellationToken)

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.

Public Method CancelChangeSet(CancelChangeSetRequest)

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.

Public Method CancelChangeSetAsync(CancelChangeSetRequest, CancellationToken)

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.

Public Method DeleteResourcePolicy(DeleteResourcePolicyRequest)

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

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

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

Public Method DescribeChangeSet(DescribeChangeSetRequest)

Provides information about a given change set.

Public Method DescribeChangeSetAsync(DescribeChangeSetRequest, CancellationToken)

Provides information about a given change set.

Public Method DescribeEntity(DescribeEntityRequest)

Returns the metadata and content of the entity.

Public Method DescribeEntityAsync(DescribeEntityRequest, CancellationToken)

Returns the metadata and content of the entity.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetResourcePolicy(GetResourcePolicyRequest)

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

Public Method GetResourcePolicyAsync(GetResourcePolicyRequest, CancellationToken)

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

Public Method ListChangeSets(ListChangeSetsRequest)

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.

Public Method ListChangeSetsAsync(ListChangeSetsRequest, CancellationToken)

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.

Public Method ListEntities(ListEntitiesRequest)

Provides the list of entities of a given type.

Public Method ListEntitiesAsync(ListEntitiesRequest, CancellationToken)

Provides the list of entities of a given type.

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Public Method PutResourcePolicy(PutResourcePolicyRequest)

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

Public Method PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken)

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

Public Method StartChangeSet(StartChangeSetRequest)

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.

Public Method StartChangeSetAsync(StartChangeSetRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

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

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

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

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5