MarketplaceCatalog

import { MarketplaceCatalog } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/marketplacecatalog.ts?docs=full";

class MarketplaceCatalog {

constructor(apiFactory: client.ApiFactory);

async batchDescribeEntities(params: BatchDescribeEntitiesRequest, opts?: client.RequestOptions): Promise<BatchDescribeEntitiesResponse>;

async cancelChangeSet(params: CancelChangeSetRequest, opts?: client.RequestOptions): Promise<CancelChangeSetResponse>;

async deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;

async describeChangeSet(params: DescribeChangeSetRequest, opts?: client.RequestOptions): Promise<DescribeChangeSetResponse>;

async describeEntity(params: DescribeEntityRequest, opts?: client.RequestOptions): Promise<DescribeEntityResponse>;

async getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>;

async listChangeSets(params: ListChangeSetsRequest, opts?: client.RequestOptions): Promise<ListChangeSetsResponse>;

async listEntities(params: ListEntitiesRequest, opts?: client.RequestOptions): Promise<ListEntitiesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;

async startChangeSet(params: StartChangeSetRequest, opts?: client.RequestOptions): Promise<StartChangeSetResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new MarketplaceCatalog(apiFactory: client.ApiFactory)

[src]

§Methods

batchDescribeEntities(params: BatchDescribeEntitiesRequest, opts?: client.RequestOptions): Promise<BatchDescribeEntitiesResponse>

[src]

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.

cancelChangeSet(params: CancelChangeSetRequest, opts?: client.RequestOptions): Promise<CancelChangeSetResponse>

[src]

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.

deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

describeChangeSet(params: DescribeChangeSetRequest, opts?: client.RequestOptions): Promise<DescribeChangeSetResponse>

[src]

Provides information about a given change set.

describeEntity(params: DescribeEntityRequest, opts?: client.RequestOptions): Promise<DescribeEntityResponse>

[src]

Returns the metadata and content of the entity.

getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>

[src]

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

listChangeSets(params: ListChangeSetsRequest, opts?: client.RequestOptions): Promise<ListChangeSetsResponse>

[src]

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(params: ListEntitiesRequest, opts?: client.RequestOptions): Promise<ListEntitiesResponse>

[src]

Provides the list of entities of a given type.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

startChangeSet(params: StartChangeSetRequest, opts?: client.RequestOptions): Promise<StartChangeSetResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]