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.
385 386 387 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 385 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.
429 430 431 432 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 429 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.
468 469 470 471 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 468 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.
492 493 494 495 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 492 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.
552 553 554 555 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 552 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.
594 595 596 597 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 594 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.
624 625 626 627 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 624 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.
699 700 701 702 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 699 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.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1020 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).
1059 1060 1061 1062 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1059 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
.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1087 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.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1197 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).
1235 1236 1237 1238 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1235 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).
1269 1270 1271 1272 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1269 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |