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
-
#cancel_change_set(params = {}) ⇒ Types::CancelChangeSetResponse
Used to cancel an open change request.
-
#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.
-
#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.
-
#start_change_set(params = {}) ⇒ Types::StartChangeSetResponse
This operation allows you to request changes for your entities.
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.
324 325 326 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#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.
364 365 366 367 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 364 def cancel_change_set(params = {}, = {}) req = build_request(:cancel_change_set, params) req.send_request() end |
#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetResponse
Provides information about a given change set.
421 422 423 424 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 421 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.
462 463 464 465 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 462 def describe_entity(params = {}, = {}) req = build_request(:describe_entity, 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.
537 538 539 540 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 537 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.
606 607 608 609 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 606 def list_entities(params = {}, = {}) req = build_request(:list_entities, params) req.send_request() end |
#start_change_set(params = {}) ⇒ Types::StartChangeSetResponse
This operation allows you to request changes for your entities. Within
a single ChangeSet, you cannot 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 ChangeSet has completed (either succeeded, cancelled, or failed).
If you try to start a ChangeSet containing a change against an entity
that is already locked, you will receive a ResourceInUseException
.
For example, you cannot start the ChangeSet described in the
example below because it contains two changes to execute the same
change type (AddRevisions
) against the same entity (entity-id@1)
.
672 673 674 675 |
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 672 def start_change_set(params = {}, = {}) req = build_request(:start_change_set, params) req.send_request() end |