Class: Aws::MarketplaceCatalog::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MarketplaceCatalog::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb
Overview
An API client for MarketplaceCatalog. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MarketplaceCatalog::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_describe_entities(params = {}) ⇒ Types::BatchDescribeEntitiesResponse
Returns metadata and content for multiple entities.
-
#cancel_change_set(params = {}) ⇒ Types::CancelChangeSetResponse
Used to cancel an open change request.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource-based policy on an entity that is identified by its resource ARN.
-
#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetResponse
Provides information about a given change set.
-
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Returns the metadata and content of the entity.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets a resource-based policy of an entity that is identified by its resource ARN.
-
#list_change_sets(params = {}) ⇒ Types::ListChangeSetsResponse
Returns the list of change sets owned by the account being used to make the call.
-
#list_entities(params = {}) ⇒ Types::ListEntitiesResponse
Provides the list of entities of a given type.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags that have been added to a resource (either an [entity][1] or [change set][2]).
-
#put_resource_policy(params = {}) ⇒ Struct
Attaches a resource-based policy to an entity.
-
#start_change_set(params = {}) ⇒ Types::StartChangeSetResponse
Allows you to request changes for your entities.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource (either an [entity][1] or [change set][2]).
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag or list of tags from a resource (either an [entity][1] or [change set][2]).
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#batch_describe_entities(params = {}) ⇒ Types::BatchDescribeEntitiesResponse
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.
454 455 456 457 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 454 def batch_describe_entities(params = {}, = {}) req = build_request(:batch_describe_entities, params) req.send_request() end |
#cancel_change_set(params = {}) ⇒ Types::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.
493 494 495 496 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 493 def cancel_change_set(params = {}, = {}) req = build_request(:cancel_change_set, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource-based policy on an entity that is identified by its resource ARN.
517 518 519 520 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 517 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetResponse
Provides information about a given change set.
577 578 579 580 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 577 def describe_change_set(params = {}, = {}) req = build_request(:describe_change_set, params) req.send_request() end |
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Returns the metadata and content of the entity.
619 620 621 622 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 619 def describe_entity(params = {}, = {}) req = build_request(:describe_entity, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets a resource-based policy of an entity that is identified by its resource ARN.
649 650 651 652 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 649 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#list_change_sets(params = {}) ⇒ Types::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.
You can describe a change during the 60-day request history retention period for API calls.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
724 725 726 727 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 724 def list_change_sets(params = {}, = {}) req = build_request(:list_change_sets, params) req.send_request() end |
#list_entities(params = {}) ⇒ Types::ListEntitiesResponse
Provides the list of entities of a given type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1045 def list_entities(params = {}, = {}) req = build_request(:list_entities, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags that have been added to a resource (either an entity or change set).
1084 1085 1086 1087 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1084 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Struct
Attaches a resource-based policy to an entity. Examples of an entity
include: AmiProduct
and ContainerProduct
.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1112 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#start_change_set(params = {}) ⇒ Types::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 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.
1222 1223 1224 1225 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1222 def start_change_set(params = {}, = {}) req = build_request(:start_change_set, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource (either an entity or change set).
1260 1261 1262 1263 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1260 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag or list of tags from a resource (either an entity or change set).
1294 1295 1296 1297 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1294 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |