Marketplace Catalog
This page documents function available when using the Marketplace_Catalog module, created with @service Marketplace_Catalog.
Index
Main.Marketplace_Catalog.cancel_change_setMain.Marketplace_Catalog.delete_resource_policyMain.Marketplace_Catalog.describe_change_setMain.Marketplace_Catalog.describe_entityMain.Marketplace_Catalog.get_resource_policyMain.Marketplace_Catalog.list_change_setsMain.Marketplace_Catalog.list_entitiesMain.Marketplace_Catalog.list_tags_for_resourceMain.Marketplace_Catalog.put_resource_policyMain.Marketplace_Catalog.start_change_setMain.Marketplace_Catalog.tag_resourceMain.Marketplace_Catalog.untag_resource
Documentation
Main.Marketplace_Catalog.cancel_change_set — Methodcancel_change_set(catalog, change_set_id)
cancel_change_set(catalog, change_set_id, params::Dict{String,<:Any})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.
Arguments
catalog: Required. The catalog related to the request. Fixed value: AWSMarketplace.change_set_id: Required. The unique identifier of the StartChangeSet request that you want to cancel.
Main.Marketplace_Catalog.delete_resource_policy — Methoddelete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})Deletes a resource-based policy on an Entity that is identified by its resource ARN.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the Entity resource that is associated with the resource policy.
Main.Marketplace_Catalog.describe_change_set — Methoddescribe_change_set(catalog, change_set_id)
describe_change_set(catalog, change_set_id, params::Dict{String,<:Any})Provides information about a given change set.
Arguments
catalog: Required. The catalog related to the request. Fixed value: AWSMarketplacechange_set_id: Required. The unique identifier for the StartChangeSet request that you want to describe the details for.
Main.Marketplace_Catalog.describe_entity — Methoddescribe_entity(catalog, entity_id)
describe_entity(catalog, entity_id, params::Dict{String,<:Any})Returns the metadata and content of the entity.
Arguments
catalog: Required. The catalog related to the request. Fixed value: AWSMarketplaceentity_id: Required. The unique ID of the entity to describe.
Main.Marketplace_Catalog.get_resource_policy — Methodget_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})Gets a resource-based policy of an Entity that is identified by its resource ARN.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the Entity resource that is associated with the resource policy.
Main.Marketplace_Catalog.list_change_sets — Methodlist_change_sets(catalog)
list_change_sets(catalog, params::Dict{String,<:Any})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.
Arguments
catalog: The catalog related to the request. Fixed value: AWSMarketplace
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"FilterList": An array of filter objects."MaxResults": 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"NextToken": The token value retrieved from a previous call to access the next page of results."Sort": An object that contains two attributes, SortBy and SortOrder.
Main.Marketplace_Catalog.list_entities — Methodlist_entities(catalog, entity_type)
list_entities(catalog, entity_type, params::Dict{String,<:Any})Provides the list of entities of a given type.
Arguments
catalog: The catalog related to the request. Fixed value: AWSMarketplaceentity_type: The type of entities to retrieve.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"FilterList": An array of filter objects. Each filter object contains two attributes, filterName and filterValues."MaxResults": Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20."NextToken": The value of the next token, if it exists. Null if there are no more results."OwnershipType":"Sort": An object that contains two attributes, SortBy and SortOrder.
Main.Marketplace_Catalog.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists all tags that have been added to a resource (either an entity or change set).
Arguments
resource_arn: Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
Main.Marketplace_Catalog.put_resource_policy — Methodput_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})Attaches a resource-based policy to an Entity. Examples of an entity include: AmiProduct and ContainerProduct.
Arguments
policy: The policy document to set; formatted in JSON.resource_arn: The Amazon Resource Name (ARN) of the Entity resource you want to associate with a resource policy.
Main.Marketplace_Catalog.start_change_set — Methodstart_change_set(catalog, change_set)
start_change_set(catalog, change_set, params::Dict{String,<:Any})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 on change types for single-AMI products, see Working with single-AMI products. Als, for more information on change types available for container-based products, see Working with container products.
Arguments
catalog: The catalog related to the request. Fixed value: AWSMarketplacechange_set: Array of change object.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ChangeSetName": 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": A list of objects specifying each key name and value for the ChangeSetTags property."ClientRequestToken": A unique token to identify the request to ensure idempotency.
Main.Marketplace_Catalog.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Tags a resource (either an entity or change set).
Arguments
resource_arn: Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.tags: Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.
Main.Marketplace_Catalog.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes a tag or list of tags from a resource (either an entity or change set).
Arguments
resource_arn: Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.tag_keys: Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.