class Aws::MarketplaceCatalog::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-marketplacecatalog/client.rb, line 713 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-marketplacecatalog/client.rb, line 324 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-marketplacecatalog/client.rb, line 688 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-marketplacecatalog' context[:gem_version] = '1.15.0' Seahorse::Client::Request.new(handlers, context) end
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.
@option params [required, String] :catalog
Required. The catalog related to the request. Fixed value: `AWSMarketplace`.
@option params [required, String] :change_set_id
Required. The unique identifier of the `StartChangeSet` request that you want to cancel.
@return [Types::CancelChangeSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CancelChangeSetResponse#change_set_id #change_set_id} => String * {Types::CancelChangeSetResponse#change_set_arn #change_set_arn} => String
@example Request syntax with placeholder values
resp = client.cancel_change_set({ catalog: "Catalog", # required change_set_id: "ResourceId", # required })
@example Response structure
resp.change_set_id #=> String resp.change_set_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/CancelChangeSet AWS API Documentation
@overload cancel_change_set
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 364 def cancel_change_set(params = {}, options = {}) req = build_request(:cancel_change_set, params) req.send_request(options) end
Provides information about a given change set.
@option params [required, String] :catalog
Required. The catalog related to the request. Fixed value: `AWSMarketplace`
@option params [required, String] :change_set_id
Required. The unique identifier for the `StartChangeSet` request that you want to describe the details for.
@return [Types::DescribeChangeSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeChangeSetResponse#change_set_id #change_set_id} => String * {Types::DescribeChangeSetResponse#change_set_arn #change_set_arn} => String * {Types::DescribeChangeSetResponse#change_set_name #change_set_name} => String * {Types::DescribeChangeSetResponse#start_time #start_time} => String * {Types::DescribeChangeSetResponse#end_time #end_time} => String * {Types::DescribeChangeSetResponse#status #status} => String * {Types::DescribeChangeSetResponse#failure_code #failure_code} => String * {Types::DescribeChangeSetResponse#failure_description #failure_description} => String * {Types::DescribeChangeSetResponse#change_set #change_set} => Array<Types::ChangeSummary>
@example Request syntax with placeholder values
resp = client.describe_change_set({ catalog: "Catalog", # required change_set_id: "ResourceId", # required })
@example Response structure
resp.change_set_id #=> String resp.change_set_arn #=> String resp.change_set_name #=> String resp.start_time #=> String resp.end_time #=> String resp.status #=> String, one of "PREPARING", "APPLYING", "SUCCEEDED", "CANCELLED", "FAILED" resp.failure_code #=> String, one of "CLIENT_ERROR", "SERVER_FAULT" resp.failure_description #=> String resp.change_set #=> Array resp.change_set[0].change_type #=> String resp.change_set[0].entity.type #=> String resp.change_set[0].entity.identifier #=> String resp.change_set[0].details #=> String resp.change_set[0].error_detail_list #=> Array resp.change_set[0].error_detail_list[0].error_code #=> String resp.change_set[0].error_detail_list[0].error_message #=> String resp.change_set[0].change_name #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeChangeSet AWS API Documentation
@overload describe_change_set
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 422 def describe_change_set(params = {}, options = {}) req = build_request(:describe_change_set, params) req.send_request(options) end
Returns the metadata and content of the entity.
@option params [required, String] :catalog
Required. The catalog related to the request. Fixed value: `AWSMarketplace`
@option params [required, String] :entity_id
Required. The unique ID of the entity to describe.
@return [Types::DescribeEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeEntityResponse#entity_type #entity_type} => String * {Types::DescribeEntityResponse#entity_identifier #entity_identifier} => String * {Types::DescribeEntityResponse#entity_arn #entity_arn} => String * {Types::DescribeEntityResponse#last_modified_date #last_modified_date} => String * {Types::DescribeEntityResponse#details #details} => String
@example Request syntax with placeholder values
resp = client.describe_entity({ catalog: "Catalog", # required entity_id: "ResourceId", # required })
@example Response structure
resp.entity_type #=> String resp.entity_identifier #=> String resp.entity_arn #=> String resp.last_modified_date #=> String resp.details #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeEntity AWS API Documentation
@overload describe_entity
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 463 def describe_entity(params = {}, options = {}) req = build_request(:describe_entity, params) req.send_request(options) end
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.
@option params [required, String] :catalog
The catalog related to the request. Fixed value: `AWSMarketplace`
@option params [Array<Types::Filter>] :filter_list
An array of filter objects.
@option params [Types::Sort] :sort
An object that contains two attributes, `SortBy` and `SortOrder`.
@option params [Integer] :max_results
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 20.
@option params [String] :next_token
The token value retrieved from a previous call to access the next page of results.
@return [Types::ListChangeSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListChangeSetsResponse#change_set_summary_list #change_set_summary_list} => Array<Types::ChangeSetSummaryListItem> * {Types::ListChangeSetsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_change_sets({ catalog: "Catalog", # required filter_list: [ { name: "FilterName", value_list: ["FilterValueContent"], }, ], sort: { sort_by: "SortBy", sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING }, max_results: 1, next_token: "NextToken", })
@example Response structure
resp.change_set_summary_list #=> Array resp.change_set_summary_list[0].change_set_id #=> String resp.change_set_summary_list[0].change_set_arn #=> String resp.change_set_summary_list[0].change_set_name #=> String resp.change_set_summary_list[0].start_time #=> String resp.change_set_summary_list[0].end_time #=> String resp.change_set_summary_list[0].status #=> String, one of "PREPARING", "APPLYING", "SUCCEEDED", "CANCELLED", "FAILED" resp.change_set_summary_list[0].entity_id_list #=> Array resp.change_set_summary_list[0].entity_id_list[0] #=> String resp.change_set_summary_list[0].failure_code #=> String, one of "CLIENT_ERROR", "SERVER_FAULT" resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListChangeSets AWS API Documentation
@overload list_change_sets
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 538 def list_change_sets(params = {}, options = {}) req = build_request(:list_change_sets, params) req.send_request(options) end
Provides the list of entities of a given type.
@option params [required, String] :catalog
The catalog related to the request. Fixed value: `AWSMarketplace`
@option params [required, String] :entity_type
The type of entities to retrieve.
@option params [Array<Types::Filter>] :filter_list
An array of filter objects. Each filter object contains two attributes, `filterName` and `filterValues`.
@option params [Types::Sort] :sort
An object that contains two attributes, `SortBy` and `SortOrder`.
@option params [String] :next_token
The value of the next token, if it exists. Null if there are no more results.
@option params [Integer] :max_results
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
@return [Types::ListEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListEntitiesResponse#entity_summary_list #entity_summary_list} => Array<Types::EntitySummary> * {Types::ListEntitiesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_entities({ catalog: "Catalog", # required entity_type: "EntityType", # required filter_list: [ { name: "FilterName", value_list: ["FilterValueContent"], }, ], sort: { sort_by: "SortBy", sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING }, next_token: "NextToken", max_results: 1, })
@example Response structure
resp.entity_summary_list #=> Array resp.entity_summary_list[0].name #=> String resp.entity_summary_list[0].entity_type #=> String resp.entity_summary_list[0].entity_id #=> String resp.entity_summary_list[0].entity_arn #=> String resp.entity_summary_list[0].last_modified_date #=> String resp.entity_summary_list[0].visibility #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListEntities AWS API Documentation
@overload list_entities
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 607 def list_entities(params = {}, options = {}) req = build_request(:list_entities, params) req.send_request(options) end
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][1
-
later in this topic, because it contains two changes to
execute 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].
[1]: docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples [2]: docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets
@option params [required, String] :catalog
The catalog related to the request. Fixed value: `AWSMarketplace`
@option params [required, Array<Types::Change>] :change_set
Array of `change` object.
@option params [String] :change_set_name
Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.
@option params [String] :client_request_token
A unique token to identify the request to ensure idempotency.
@return [Types::StartChangeSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartChangeSetResponse#change_set_id #change_set_id} => String * {Types::StartChangeSetResponse#change_set_arn #change_set_arn} => String
@example Request syntax with placeholder values
resp = client.start_change_set({ catalog: "Catalog", # required change_set: [ # required { change_type: "ChangeType", # required entity: { # required type: "EntityType", # required identifier: "Identifier", }, details: "Json", # required change_name: "ChangeName", }, ], change_set_name: "ChangeSetName", client_request_token: "ClientRequestToken", })
@example Response structure
resp.change_set_id #=> String resp.change_set_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/StartChangeSet AWS API Documentation
@overload start_change_set
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-marketplacecatalog/client.rb, line 679 def start_change_set(params = {}, options = {}) req = build_request(:start_change_set, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-marketplacecatalog/client.rb, line 703 def waiter_names [] end