Class: Aws::MarketplaceAgreement::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::MarketplaceAgreement::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb

Overview

An API client for MarketplaceAgreement. To construct a client, you need to configure a :region and :credentials.

client = Aws::MarketplaceAgreement::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

• #describe_agreement(params = {}) ⇒ Types::DescribeAgreementOutput

  Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

• #get_agreement_terms(params = {}) ⇒ Types::GetAgreementTermsOutput

  Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

• #search_agreements(params = {}) ⇒ Types::SearchAgreementsOutput

  Searches across all agreements that a proposer has in AWS Marketplace.

Instance Method Summary

• #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.

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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.

• :auth_scheme_preference (Array<String>) —

  A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

• :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
• :simple_json (Boolean) — default: false —

  Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

• :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) —

  Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::MarketplaceAgreement::EndpointProvider) —

  The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MarketplaceAgreement::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.

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 480

def initialize(*args)
  super
end

Instance Method Details

#describe_agreement(params = {}) ⇒ Types::DescribeAgreementOutput

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Examples:

Request syntax with placeholder values

resp = client.describe_agreement({
  agreement_id: "ResourceId", # required
})

Response structure

resp.agreement_id #=> String
resp.acceptor.account_id #=> String
resp.proposer.account_id #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.acceptance_time #=> Time
resp.agreement_type #=> String
resp.estimated_charges.currency_code #=> String
resp.estimated_charges.agreement_value #=> String
resp.proposal_summary.resources #=> Array
resp.proposal_summary.resources[0].id #=> String
resp.proposal_summary.resources[0].type #=> String
resp.proposal_summary.offer_id #=> String
resp.proposal_summary.offer_set_id #=> String
resp.status #=> String, one of "ACTIVE", "ARCHIVED", "CANCELLED", "EXPIRED", "RENEWED", "REPLACED", "ROLLED_BACK", "SUPERSEDED", "TERMINATED"

Parameters:

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

  ({})

Options Hash (params):

• :agreement_id (required, String) —

  The unique identifier of the agreement.

Returns:

• (Types::DescribeAgreementOutput) —

  Returns a response object which responds to the following methods:

  • #agreement_id => String
  • #acceptor => Types::Acceptor
  • #proposer => Types::Proposer
  • #start_time => Time
  • #end_time => Time
  • #acceptance_time => Time
  • #agreement_type => String
  • #estimated_charges => Types::EstimatedCharges
  • #proposal_summary => Types::ProposalSummary
  • #status => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 533

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

#get_agreement_terms(params = {}) ⇒ Types::GetAgreementTermsOutput

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

• TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

• TermID – The ID of the particular term, which is common between offer and agreement.

• TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm. ^

• Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

^

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.get_agreement_terms({
  agreement_id: "ResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure

resp.accepted_terms #=> Array
resp.accepted_terms[0].legal_term.type #=> String
resp.accepted_terms[0].legal_term.documents #=> Array
resp.accepted_terms[0].legal_term.documents[0].type #=> String
resp.accepted_terms[0].legal_term.documents[0].url #=> String
resp.accepted_terms[0].legal_term.documents[0].version #=> String
resp.accepted_terms[0].support_term.type #=> String
resp.accepted_terms[0].support_term.refund_policy #=> String
resp.accepted_terms[0].renewal_term.type #=> String
resp.accepted_terms[0].renewal_term.configuration.enable_auto_renew #=> Boolean
resp.accepted_terms[0].usage_based_pricing_term.type #=> String
resp.accepted_terms[0].usage_based_pricing_term.currency_code #=> String
resp.accepted_terms[0].usage_based_pricing_term.rate_cards #=> Array
resp.accepted_terms[0].usage_based_pricing_term.rate_cards[0].rate_card #=> Array
resp.accepted_terms[0].usage_based_pricing_term.rate_cards[0].rate_card[0].dimension_key #=> String
resp.accepted_terms[0].usage_based_pricing_term.rate_cards[0].rate_card[0].price #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.type #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.currency_code #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards #=> Array
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].selector.type #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].selector.value #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].constraints.multiple_dimension_selection #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].constraints.quantity_configuration #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].rate_card #=> Array
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].rate_card[0].dimension_key #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.rate_cards[0].rate_card[0].price #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.configuration.selector_value #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.configuration.dimensions #=> Array
resp.accepted_terms[0].configurable_upfront_pricing_term.configuration.dimensions[0].dimension_key #=> String
resp.accepted_terms[0].configurable_upfront_pricing_term.configuration.dimensions[0].dimension_value #=> Integer
resp.accepted_terms[0].byol_pricing_term.type #=> String
resp.accepted_terms[0].recurring_payment_term.type #=> String
resp.accepted_terms[0].recurring_payment_term.currency_code #=> String
resp.accepted_terms[0].recurring_payment_term.billing_period #=> String
resp.accepted_terms[0].recurring_payment_term.price #=> String
resp.accepted_terms[0].validity_term.type #=> String
resp.accepted_terms[0].validity_term.agreement_duration #=> String
resp.accepted_terms[0].validity_term.agreement_start_date #=> Time
resp.accepted_terms[0].validity_term.agreement_end_date #=> Time
resp.accepted_terms[0].payment_schedule_term.type #=> String
resp.accepted_terms[0].payment_schedule_term.currency_code #=> String
resp.accepted_terms[0].payment_schedule_term.schedule #=> Array
resp.accepted_terms[0].payment_schedule_term.schedule[0].charge_date #=> Time
resp.accepted_terms[0].payment_schedule_term.schedule[0].charge_amount #=> String
resp.accepted_terms[0].free_trial_pricing_term.type #=> String
resp.accepted_terms[0].free_trial_pricing_term.duration #=> String
resp.accepted_terms[0].free_trial_pricing_term.grants #=> Array
resp.accepted_terms[0].free_trial_pricing_term.grants[0].dimension_key #=> String
resp.accepted_terms[0].free_trial_pricing_term.grants[0].max_quantity #=> Integer
resp.accepted_terms[0].fixed_upfront_pricing_term.type #=> String
resp.accepted_terms[0].fixed_upfront_pricing_term.currency_code #=> String
resp.accepted_terms[0].fixed_upfront_pricing_term.duration #=> String
resp.accepted_terms[0].fixed_upfront_pricing_term.price #=> String
resp.accepted_terms[0].fixed_upfront_pricing_term.grants #=> Array
resp.accepted_terms[0].fixed_upfront_pricing_term.grants[0].dimension_key #=> String
resp.accepted_terms[0].fixed_upfront_pricing_term.grants[0].max_quantity #=> Integer
resp.accepted_terms[0].variable_payment_term.type #=> String
resp.accepted_terms[0].variable_payment_term.currency_code #=> String
resp.accepted_terms[0].variable_payment_term.max_total_charge_amount #=> String
resp.accepted_terms[0].variable_payment_term.configuration.payment_request_approval_strategy #=> String, one of "AUTO_APPROVE_ON_EXPIRATION", "WAIT_FOR_APPROVAL"
resp.accepted_terms[0].variable_payment_term.configuration.expiration_duration #=> String
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :agreement_id (required, String) —

  The unique identifier of the agreement.

• :max_results (Integer) —

  The maximum number of agreements to return in the response.

• :next_token (String) —

  A token to specify where to start pagination

Returns:

• (Types::GetAgreementTermsOutput) —

  Returns a response object which responds to the following methods:

  • #accepted_terms => Array<Types::AcceptedTerm>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 654

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

#search_agreements(params = {}) ⇒ Types::SearchAgreementsOutput

Searches across all agreements that a proposer has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

The following filter combinations are supported when the PartyType is Proposer:

• AgreementType

• AgreementType + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceId

• AgreementType + ResourceId + EndTime

• AgreementType + ResourceId + Status

• AgreementType + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceId

• AgreementType + AcceptorAccountId + ResourceId + Status

• AgreementType + AcceptorAccountId + ResourceId + EndTime

• AgreementType + AcceptorAccountId + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

To filter by EndTime, you can use either BeforeEndTime or AfterEndTime. Only EndTime is supported for sorting.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.search_agreements({
  catalog: "Catalog",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
  sort: {
    sort_by: "SortBy",
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure

resp.agreement_view_summaries #=> Array
resp.agreement_view_summaries[0].agreement_id #=> String
resp.agreement_view_summaries[0].acceptance_time #=> Time
resp.agreement_view_summaries[0].start_time #=> Time
resp.agreement_view_summaries[0].end_time #=> Time
resp.agreement_view_summaries[0].agreement_type #=> String
resp.agreement_view_summaries[0].acceptor.account_id #=> String
resp.agreement_view_summaries[0].proposer.account_id #=> String
resp.agreement_view_summaries[0].proposal_summary.resources #=> Array
resp.agreement_view_summaries[0].proposal_summary.resources[0].id #=> String
resp.agreement_view_summaries[0].proposal_summary.resources[0].type #=> String
resp.agreement_view_summaries[0].proposal_summary.offer_id #=> String
resp.agreement_view_summaries[0].proposal_summary.offer_set_id #=> String
resp.agreement_view_summaries[0].status #=> String, one of "ACTIVE", "ARCHIVED", "CANCELLED", "EXPIRED", "RENEWED", "REPLACED", "ROLLED_BACK", "SUPERSEDED", "TERMINATED"
resp.next_token #=> String

Parameters:

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

  ({})

Options Hash (params):

• :catalog (String) —

  The catalog in which the agreement was created.

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

  The filter name and value pair used to return a specific list of results.

  The following filters are supported:

  • ResourceIdentifier – The unique identifier of the resource.

  • ResourceType – Type of the resource, which is the product (AmiProduct, ContainerProduct, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).

  • PartyType – The party type of the caller. For agreements where the caller is the proposer, use the Proposer filter.

  • AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.

  • OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.

  • Status – The current status of the agreement. Values include ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, and TERMINATED.

  • BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.

  • AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.

  • AgreementType – The type of agreement. Supported value includes PurchaseAgreement.

  • OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.

• :sort (Types::Sort) —

  An object that contains the SortBy and SortOrder attributes. Only EndTime is supported for SearchAgreements. The default sort is EndTime descending.

• :max_results (Integer) —

  The maximum number of agreements to return in the response.

• :next_token (String) —

  A token to specify where to start pagination.

Returns:

• (Types::SearchAgreementsOutput) —

  Returns a response object which responds to the following methods:

  • #agreement_view_summaries => Array<Types::AgreementViewSummary>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 845

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