Class: Aws::MarketplaceCatalog::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    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
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :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

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: 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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MarketplaceCatalog::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MarketplaceCatalog::EndpointParameters.

  • :http_continue_timeout (Float) — default: 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.

  • :http_idle_timeout (Float) — default: 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.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



466
467
468
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 466

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.

Examples:

Request syntax with placeholder values


resp = client.batch_describe_entities({
  entity_request_list: [ # required
    {
      catalog: "Catalog", # required
      entity_id: "EntityId", # required
    },
  ],
})

Response structure


resp.entity_details #=> Hash
resp.entity_details["EntityId"].entity_type #=> String
resp.entity_details["EntityId"].entity_arn #=> String
resp.entity_details["EntityId"].entity_identifier #=> String
resp.entity_details["EntityId"].last_modified_date #=> String
resp.errors #=> Hash
resp.errors["EntityId"].error_code #=> String
resp.errors["EntityId"].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entity_request_list (required, Array<Types::EntityRequest>) —

    List of entity IDs and the catalogs the entities are present in.

Returns:

See Also:



510
511
512
513
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 510

def batch_describe_entities(params = {}, options = {})
  req = build_request(:batch_describe_entities, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.cancel_change_set({
  catalog: "Catalog", # required
  change_set_id: "ResourceId", # required
})

Response structure


resp.change_set_id #=> String
resp.change_set_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Required. The catalog related to the request. Fixed value: AWSMarketplace.

  • :change_set_id (required, String) —

    Required. The unique identifier of the StartChangeSet request that you want to cancel.

Returns:

See Also:



549
550
551
552
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 549

def cancel_change_set(params = {}, options = {})
  req = build_request(:cancel_change_set, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource-based policy on an entity that is identified by its resource ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceARN", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



573
574
575
576
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 573

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetResponse

Provides information about a given change set.

Examples:

Request syntax with placeholder values


resp = client.describe_change_set({
  catalog: "Catalog", # required
  change_set_id: "ResourceId", # required
})

Response structure


resp.change_set_id #=> String
resp.change_set_arn #=> String
resp.change_set_name #=> String
resp.intent #=> String, one of "VALIDATE", "APPLY"
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Required. The catalog related to the request. Fixed value: AWSMarketplace

  • :change_set_id (required, String) —

    Required. The unique identifier for the StartChangeSet request that you want to describe the details for.

Returns:

See Also:



633
634
635
636
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 633

def describe_change_set(params = {}, options = {})
  req = build_request(:describe_change_set, params)
  req.send_request(options)
end

#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse

Returns the metadata and content of the entity.

Examples:

Request syntax with placeholder values


resp = client.describe_entity({
  catalog: "Catalog", # required
  entity_id: "ResourceId", # required
})

Response structure


resp.entity_type #=> String
resp.entity_identifier #=> String
resp.entity_arn #=> String
resp.last_modified_date #=> String
resp.details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Required. The catalog related to the request. Fixed value: AWSMarketplace

  • :entity_id (required, String) —

    Required. The unique ID of the entity to describe.

Returns:

See Also:



675
676
677
678
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 675

def describe_entity(params = {}, options = {})
  req = build_request(:describe_entity, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Gets a resource-based policy of an entity that is identified by its resource ARN.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceARN", # required
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

Returns:

See Also:



705
706
707
708
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 705

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
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.

Examples:

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",
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog related to the request. Fixed value: AWSMarketplace

  • :filter_list (Array<Types::Filter>) —

    An array of filter objects.

  • :sort (Types::Sort) —

    An object that contains two attributes, SortBy and SortOrder.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    The token value retrieved from a previous call to access the next page of results.

Returns:

See Also:



780
781
782
783
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 780

def list_change_sets(params = {}, options = {})
  req = build_request(:list_change_sets, params)
  req.send_request(options)
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.

Examples:

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,
  ownership_type: "SELF", # accepts SELF, SHARED
  entity_type_filters: {
    data_product_filters: {
      entity_id: {
        value_list: ["DataProductEntityIdString"],
      },
      product_title: {
        value_list: ["DataProductTitleString"],
        wild_card_value: "DataProductTitleString",
      },
      visibility: {
        value_list: ["Limited"], # accepts Limited, Public, Restricted, Unavailable, Draft
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
    },
    saa_s_product_filters: {
      entity_id: {
        value_list: ["SaaSProductEntityIdString"],
      },
      product_title: {
        value_list: ["SaaSProductTitleString"],
        wild_card_value: "SaaSProductTitleString",
      },
      visibility: {
        value_list: ["Limited"], # accepts Limited, Public, Restricted, Draft
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
    },
    ami_product_filters: {
      entity_id: {
        value_list: ["AmiProductEntityIdString"],
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
      product_title: {
        value_list: ["AmiProductTitleString"],
        wild_card_value: "AmiProductTitleString",
      },
      visibility: {
        value_list: ["Limited"], # accepts Limited, Public, Restricted, Draft
      },
    },
    offer_filters: {
      entity_id: {
        value_list: ["OfferEntityIdString"],
      },
      name: {
        value_list: ["OfferNameString"],
        wild_card_value: "OfferNameString",
      },
      product_id: {
        value_list: ["OfferProductIdString"],
      },
      resale_authorization_id: {
        value_list: ["OfferResaleAuthorizationIdString"],
      },
      release_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
      availability_end_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
      buyer_accounts: {
        wild_card_value: "OfferBuyerAccountsFilterWildcard",
      },
      state: {
        value_list: ["Draft"], # accepts Draft, Released
      },
      targeting: {
        value_list: ["BuyerAccounts"], # accepts BuyerAccounts, ParticipatingPrograms, CountryCodes, None
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
    },
    container_product_filters: {
      entity_id: {
        value_list: ["ContainerProductEntityIdString"],
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
      product_title: {
        value_list: ["ContainerProductTitleString"],
        wild_card_value: "ContainerProductTitleString",
      },
      visibility: {
        value_list: ["Limited"], # accepts Limited, Public, Restricted, Draft
      },
    },
    resale_authorization_filters: {
      entity_id: {
        value_list: ["ResaleAuthorizationEntityIdString"],
      },
      name: {
        value_list: ["ResaleAuthorizationNameString"],
        wild_card_value: "ResaleAuthorizationNameFilterWildcard",
      },
      product_id: {
        value_list: ["ResaleAuthorizationProductIdString"],
        wild_card_value: "ResaleAuthorizationProductIdFilterWildcard",
      },
      created_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
        value_list: ["DateTimeISO8601"],
      },
      availability_end_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
        value_list: ["DateTimeISO8601"],
      },
      manufacturer_account_id: {
        value_list: ["ResaleAuthorizationManufacturerAccountIdString"],
        wild_card_value: "ResaleAuthorizationManufacturerAccountIdFilterWildcard",
      },
      product_name: {
        value_list: ["ResaleAuthorizationProductNameString"],
        wild_card_value: "ResaleAuthorizationProductNameFilterWildcard",
      },
      manufacturer_legal_name: {
        value_list: ["ResaleAuthorizationManufacturerLegalNameString"],
        wild_card_value: "ResaleAuthorizationManufacturerLegalNameFilterWildcard",
      },
      reseller_account_id: {
        value_list: ["ResaleAuthorizationResellerAccountIDString"],
        wild_card_value: "ResaleAuthorizationResellerAccountIDFilterWildcard",
      },
      reseller_legal_name: {
        value_list: ["ResaleAuthorizationResellerLegalNameString"],
        wild_card_value: "ResaleAuthorizationResellerLegalNameFilterWildcard",
      },
      status: {
        value_list: ["Draft"], # accepts Draft, Active, Restricted
      },
      offer_extended_status: {
        value_list: ["ResaleAuthorizationOfferExtendedStatusString"],
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
    },
    machine_learning_product_filters: {
      entity_id: {
        value_list: ["MachineLearningProductEntityIdString"],
      },
      last_modified_date: {
        date_range: {
          after_value: "DateTimeISO8601",
          before_value: "DateTimeISO8601",
        },
      },
      product_title: {
        value_list: ["MachineLearningProductTitleString"],
        wild_card_value: "MachineLearningProductTitleString",
      },
      visibility: {
        value_list: ["Limited"], # accepts Limited, Public, Restricted, Draft
      },
    },
  },
  entity_type_sort: {
    data_product_sort: {
      sort_by: "EntityId", # accepts EntityId, ProductTitle, Visibility, LastModifiedDate
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    saa_s_product_sort: {
      sort_by: "EntityId", # accepts EntityId, ProductTitle, Visibility, LastModifiedDate
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    ami_product_sort: {
      sort_by: "EntityId", # accepts EntityId, LastModifiedDate, ProductTitle, Visibility
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    offer_sort: {
      sort_by: "EntityId", # accepts EntityId, Name, ProductId, ResaleAuthorizationId, ReleaseDate, AvailabilityEndDate, BuyerAccounts, State, Targeting, LastModifiedDate
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    container_product_sort: {
      sort_by: "EntityId", # accepts EntityId, LastModifiedDate, ProductTitle, Visibility
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    resale_authorization_sort: {
      sort_by: "EntityId", # accepts EntityId, Name, ProductId, ProductName, ManufacturerAccountId, ManufacturerLegalName, ResellerAccountID, ResellerLegalName, Status, OfferExtendedStatus, CreatedDate, AvailabilityEndDate, LastModifiedDate
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
    machine_learning_product_sort: {
      sort_by: "EntityId", # accepts EntityId, LastModifiedDate, ProductTitle, Visibility
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  },
})

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.entity_summary_list[0].ami_product_summary.product_title #=> String
resp.entity_summary_list[0].ami_product_summary.visibility #=> String, one of "Limited", "Public", "Restricted", "Draft"
resp.entity_summary_list[0].container_product_summary.product_title #=> String
resp.entity_summary_list[0].container_product_summary.visibility #=> String, one of "Limited", "Public", "Restricted", "Draft"
resp.entity_summary_list[0].data_product_summary.product_title #=> String
resp.entity_summary_list[0].data_product_summary.visibility #=> String, one of "Limited", "Public", "Restricted", "Unavailable", "Draft"
resp.entity_summary_list[0].saa_s_product_summary.product_title #=> String
resp.entity_summary_list[0].saa_s_product_summary.visibility #=> String, one of "Limited", "Public", "Restricted", "Draft"
resp.entity_summary_list[0].offer_summary.name #=> String
resp.entity_summary_list[0].offer_summary.product_id #=> String
resp.entity_summary_list[0].offer_summary.resale_authorization_id #=> String
resp.entity_summary_list[0].offer_summary.release_date #=> String
resp.entity_summary_list[0].offer_summary.availability_end_date #=> String
resp.entity_summary_list[0].offer_summary.buyer_accounts #=> Array
resp.entity_summary_list[0].offer_summary.buyer_accounts[0] #=> String
resp.entity_summary_list[0].offer_summary.state #=> String, one of "Draft", "Released"
resp.entity_summary_list[0].offer_summary.targeting #=> Array
resp.entity_summary_list[0].offer_summary.targeting[0] #=> String, one of "BuyerAccounts", "ParticipatingPrograms", "CountryCodes", "None"
resp.entity_summary_list[0].resale_authorization_summary.name #=> String
resp.entity_summary_list[0].resale_authorization_summary.product_id #=> String
resp.entity_summary_list[0].resale_authorization_summary.product_name #=> String
resp.entity_summary_list[0].resale_authorization_summary. #=> String
resp.entity_summary_list[0].resale_authorization_summary.manufacturer_legal_name #=> String
resp.entity_summary_list[0].resale_authorization_summary. #=> String
resp.entity_summary_list[0].resale_authorization_summary.reseller_legal_name #=> String
resp.entity_summary_list[0].resale_authorization_summary.status #=> String, one of "Draft", "Active", "Restricted"
resp.entity_summary_list[0].resale_authorization_summary.offer_extended_status #=> String
resp.entity_summary_list[0].resale_authorization_summary.created_date #=> String
resp.entity_summary_list[0].resale_authorization_summary.availability_end_date #=> String
resp.entity_summary_list[0].machine_learning_product_summary.product_title #=> String
resp.entity_summary_list[0].machine_learning_product_summary.visibility #=> String, one of "Limited", "Public", "Restricted", "Draft"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog related to the request. Fixed value: AWSMarketplace

  • :entity_type (required, String) —

    The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

  • :filter_list (Array<Types::Filter>) —

    An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

  • :sort (Types::Sort) —

    An object that contains two attributes, SortBy and SortOrder.

  • :next_token (String) —

    The value of the next token, if it exists. Null if there are no more results.

  • :max_results (Integer) —

    Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

  • :ownership_type (String) —

    Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

  • :entity_type_filters (Types::EntityTypeFilters) —

    A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

  • :entity_type_sort (Types::EntityTypeSort) —

    A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

Returns:

See Also:



1125
1126
1127
1128
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1125

def list_entities(params = {}, options = {})
  req = build_request(:list_entities, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags that have been added to a resource (either an entity or change set).

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceARN", # required
})

Response structure


resp.resource_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

Returns:

See Also:



1164
1165
1166
1167
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1164

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Struct

Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ResourceARN", # required
  policy: "ResourcePolicyJson", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy.

  • :policy (required, String) —

    The policy document to set; formatted in JSON.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1192
1193
1194
1195
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1192

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
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.

To download "DetailsDocument" shapes, see Python and Java shapes on GitHub.

Examples:

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",
      },
      entity_tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      details: "Json",
      details_document: {
      },
      change_name: "ChangeName",
    },
  ],
  change_set_name: "ChangeSetName",
  client_request_token: "ClientRequestToken",
  change_set_tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  intent: "VALIDATE", # accepts VALIDATE, APPLY
})

Response structure


resp.change_set_id #=> String
resp.change_set_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog related to the request. Fixed value: AWSMarketplace

  • :change_set (required, Array<Types::Change>) —

    Array of change object.

  • :change_set_name (String) —

    Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.

  • :client_request_token (String) —

    A unique token to identify the request to ensure idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :change_set_tags (Array<Types::Tag>) —

    A list of objects specifying each key name and value for the ChangeSetTags property.

  • :intent (String) —

    The intent related to the request. The default is APPLY. To test your request before applying changes to your entities, use VALIDATE. This feature is currently available for adding versions to single-AMI products. For more information, see Add a new version.

Returns:

See Also:



1307
1308
1309
1310
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1307

def start_change_set(params = {}, options = {})
  req = build_request(:start_change_set, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags a resource (either an entity or change set).

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.

  • :tags (required, Array<Types::Tag>) —

    Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1345
1346
1347
1348
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1345

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a tag or list of tags from a resource (either an entity or change set).

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceARN", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

  • :tag_keys (required, Array<String>) —

    Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1379
1380
1381
1382
 
# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/client.rb', line 1379

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end