Class: Aws::MarketplaceAgreement::Client

Inherits:
Seahorse::Client::Base show all
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 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 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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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



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

def initialize(*args)
  super
end

Instance Method Details

#accept_agreement_cancellation_request(params = {}) ⇒ Types::AcceptAgreementCancellationRequestOutput

Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.

Only cancellation requests in PENDING_APPROVAL status can be accepted. A ConflictException is thrown if the cancellation request is in any other status.

Examples:

Request syntax with placeholder values


resp = client.accept_agreement_cancellation_request({
  agreement_id: "AgreementId", # required
  agreement_cancellation_request_id: "AgreementCancellationRequestId", # required
})

Response structure


resp.agreement_id #=> String
resp.agreement_cancellation_request_id #=> String
resp.status #=> String, one of "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED", "VALIDATION_FAILED"
resp.reason_code #=> String, one of "INCORRECT_TERMS_ACCEPTED", "REPLACING_AGREEMENT", "TEST_AGREEMENT", "ALTERNATIVE_PROCUREMENT_CHANNEL", "PRODUCT_DISCONTINUED", "UNINTENDED_RENEWAL", "BUYER_DISSATISFACTION", "OTHER"
resp.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the cancellation request.

  • :agreement_cancellation_request_id (required, String) —

    The unique identifier of the cancellation request to accept.

Returns:

See Also:



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

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

#accept_agreement_payment_request(params = {}) ⇒ Types::AcceptAgreementPaymentRequestOutput

Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.

Only payment requests in PENDING_APPROVAL status can be accepted. A ConflictException is thrown if the payment request is in any other status.

Examples:

Request syntax with placeholder values


resp = client.accept_agreement_payment_request({
  payment_request_id: "PaymentRequestId", # required
  agreement_id: "AgreementId", # required
  purchase_order_reference: "PurchaseOrderReference",
})

Response structure


resp.payment_request_id #=> String
resp.agreement_id #=> String
resp.status #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED"
resp.name #=> String
resp.description #=> String
resp.charge_amount #=> String
resp.currency_code #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :payment_request_id (required, String) —

    The unique identifier of the payment request to accept.

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the payment request.

  • :purchase_order_reference (String) —

    An optional purchase order reference that buyers can provide to associate the payment request with their internal purchase order system.

Returns:

See Also:



598
599
600
601
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 598

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

#accept_agreement_request(params = {}) ⇒ Types::AcceptAgreementRequestOutput

Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.

Examples:

Request syntax with placeholder values


resp = client.accept_agreement_request({
  agreement_request_id: "AgreementRequestId", # required
  purchase_orders: [
    {
      charge_id: "ResourceId", # required
      charge_revision: 1,
      agreement_id: "ResourceId",
      purchase_order_reference: "PurchaseOrderReference",
    },
  ],
})

Response structure


resp.agreement_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :agreement_request_id (required, String) —

    The unique identifier of the agreement request.

  • :purchase_orders (Array<Types::PurchaseOrder>) —

    A list of purchase orders associated with accepting a marketplace agreement request.

Returns:

See Also:



640
641
642
643
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 640

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

#batch_create_billing_adjustment_request(params = {}) ⇒ Types::BatchCreateBillingAdjustmentRequestOutput

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.

Each entry requires a unique clientToken for idempotency.

Examples:

Example: Create billing adjustment requests


resp = client.batch_create_billing_adjustment_request({
  billing_adjustment_request_entries: [
    {
      adjustment_amount: "500.00", 
      adjustment_reason_code: "OTHER", 
      agreement_id: "agmt-SvIzsqYMyQwI3GWgJAe17URx", 
      client_token: "71a5e82e-a49b-4075-8c7f-52df1d294379", 
      currency_code: "USD", 
      description: "Customer requested adjustment due to service outage during critical business period.", 
      original_invoice_id: "E2E20230929a108cfae", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  items: [
    {
      billing_adjustment_request_id: "ba-1a2b3c4d5e6f7g", 
      client_token: "71a5e82e-a49b-4075-8c7f-52df1d294379", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.batch_create_billing_adjustment_request({
  billing_adjustment_request_entries: [ # required
    {
      agreement_id: "AgreementId", # required
      original_invoice_id: "InvoiceId", # required
      adjustment_amount: "PositiveAmountUpto8Decimals", # required
      currency_code: "CurrencyCode", # required
      adjustment_reason_code: "INCORRECT_TERMS_ACCEPTED", # required, accepts INCORRECT_TERMS_ACCEPTED, INCORRECT_METERING, TEST_ENVIRONMENT_CHARGES, ALTERNATIVE_PROCUREMENT_CHANNEL, UNINTENDED_RENEWAL, BUYER_DISSATISFACTION, OTHER
      description: "BillingAdjustmentDescription",
      client_token: "ClientToken", # required
    },
  ],
})

Response structure


resp.items #=> Array
resp.items[0].billing_adjustment_request_id #=> String
resp.items[0].client_token #=> String
resp.errors #=> Array
resp.errors[0].code #=> String, one of "CONFLICT_EXCEPTION", "VALIDATION_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "INTERNAL_FAILURE"
resp.errors[0].message #=> String
resp.errors[0].client_token #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



723
724
725
726
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 723

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

#cancel_agreement(params = {}) ⇒ Struct

Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :agreement_id (required, String) —

    The unique identifier of the agreement.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



747
748
749
750
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 747

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

#cancel_agreement_cancellation_request(params = {}) ⇒ Types::CancelAgreementCancellationRequestOutput

Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to CANCELLED status and can no longer be approved or rejected by the buyer.

Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.

Examples:

Example: Cancel a cancellation request


resp = client.cancel_agreement_cancellation_request({
  agreement_cancellation_request_id: "acr-752jqvg74yo7k4h56cakk6396", 
  agreement_id: "agmt-752jqvg74yo7k4h56cakk6396", 
  cancellation_reason: "Requested agreement cancellation by mistake", 
})

resp.to_h outputs the following:
{
  agreement_cancellation_request_id: "acr-752jqvg74yo7k4h56cakk6396", 
  agreement_id: "agmt-752jqvg74yo7k4h56cakk6396", 
  created_at: Time.parse("2025-01-15T10:30:00Z"), 
  description: "Product is being discontinued and no longer supported", 
  reason_code: "PRODUCT_DISCONTINUED", 
  status: "CANCELLED", 
  status_message: "Cancellation requested by seller", 
  updated_at: Time.parse("2025-01-16T10:30:00Z"), 
}

Request syntax with placeholder values


resp = client.cancel_agreement_cancellation_request({
  agreement_id: "AgreementId", # required
  agreement_cancellation_request_id: "AgreementCancellationRequestId", # required
  cancellation_reason: "AgreementCancellationRequestCancellationReason", # required
})

Response structure


resp.agreement_cancellation_request_id #=> String
resp.agreement_id #=> String
resp.reason_code #=> String, one of "INCORRECT_TERMS_ACCEPTED", "REPLACING_AGREEMENT", "TEST_AGREEMENT", "ALTERNATIVE_PROCUREMENT_CHANNEL", "PRODUCT_DISCONTINUED", "UNINTENDED_RENEWAL", "BUYER_DISSATISFACTION", "OTHER"
resp.description #=> String
resp.status #=> String, one of "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED", "VALIDATION_FAILED"
resp.status_message #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the cancellation request.

  • :agreement_cancellation_request_id (required, String) —

    The unique identifier of the cancellation request to cancel.

  • :cancellation_reason (required, String) —

    A required message explaining why the cancellation request is being withdrawn (1-2000 characters).

Returns:

See Also:



829
830
831
832
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 829

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

#cancel_agreement_payment_request(params = {}) ⇒ Types::CancelAgreementPaymentRequestOutput

Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.

Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the payment request is in any other status.

Examples:

Request syntax with placeholder values


resp = client.cancel_agreement_payment_request({
  payment_request_id: "PaymentRequestId", # required
  agreement_id: "AgreementId", # required
})

Response structure


resp.payment_request_id #=> String
resp.agreement_id #=> String
resp.status #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED"
resp.name #=> String
resp.description #=> String
resp.charge_amount #=> String
resp.currency_code #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :payment_request_id (required, String) —

    The unique identifier of the payment request to cancel.

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the payment request.

Returns:

See Also:



887
888
889
890
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 887

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

#create_agreement_request(params = {}) ⇒ Types::CreateAgreementRequestOutput

Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.

Examples:

Request syntax with placeholder values


resp = client.create_agreement_request({
  client_token: "ClientToken",
  intent: "NEW", # required, accepts NEW, AMEND, REPLACE
  requested_terms: [ # required
    {
      id: "TermId", # required
      configuration: {
        configurable_upfront_pricing_term_configuration: {
          selector_value: "BoundedString", # required
          dimensions: [ # required
            {
              dimension_key: "BoundedString", # required
              dimension_value: 1, # required
            },
          ],
        },
        renewal_term_configuration: {
          enable_auto_renew: false, # required
        },
        variable_payment_term_configuration: {
          payment_request_approval_strategy: "AUTO_APPROVE_ON_EXPIRATION", # required, accepts AUTO_APPROVE_ON_EXPIRATION, WAIT_FOR_APPROVAL
          expiration_duration: "ISO8601Duration",
        },
      },
    },
  ],
  source_agreement_identifier: "ResourceId",
  agreement_proposal_identifier: "AgreementProposalId",
  tax_configuration: {
    tax_estimation: "DISABLED", # accepts DISABLED, ENABLED
  },
})

Response structure


resp.agreement_request_id #=> String
resp.charge_summary.currency_code #=> String
resp.charge_summary.new_agreement_value #=> String
resp.charge_summary.new_agreement_value_after_tax #=> String
resp.charge_summary.expected_charges #=> Array
resp.charge_summary.expected_charges[0].id #=> String
resp.charge_summary.expected_charges[0].time #=> Time
resp.charge_summary.expected_charges[0].amount #=> String
resp.charge_summary.expected_charges[0].amount_after_tax #=> String
resp.charge_summary.expected_charges[0].timing #=> String, one of "ON_ACCEPTANCE", "SCHEDULED", "BILLING_PERIOD"
resp.charge_summary.expected_charges[0].estimated_taxes.breakdown #=> Array
resp.charge_summary.expected_charges[0].estimated_taxes.breakdown[0].amount #=> String
resp.charge_summary.expected_charges[0].estimated_taxes.breakdown[0].rate #=> String
resp.charge_summary.expected_charges[0].estimated_taxes.breakdown[0].type #=> String
resp.charge_summary.expected_charges[0].estimated_taxes.total_amount #=> String
resp.charge_summary.estimated_taxes.breakdown #=> Array
resp.charge_summary.estimated_taxes.breakdown[0].amount #=> String
resp.charge_summary.estimated_taxes.breakdown[0].rate #=> String
resp.charge_summary.estimated_taxes.breakdown[0].type #=> String
resp.charge_summary.estimated_taxes.total_amount #=> String
resp.charge_summary.itemized_charges #=> Array
resp.charge_summary.itemized_charges[0].dimension_key #=> String
resp.charge_summary.itemized_charges[0].new_quantity #=> Integer
resp.charge_summary.itemized_charges[0].old_quantity #=> Integer
resp.charge_summary.itemized_charges[0].charge_reference #=> String
resp.charge_summary.itemized_charges[0].incremental_charge_amount #=> String
resp.charge_summary.invoicing_entity.legal_name #=> String
resp.charge_summary.invoicing_entity.branch_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

  • :intent (required, String) —

    The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

    • NEW – Creates a new agreement for terms in the request.

    • AMEND – Modifies an existing agreement with terms that are accepted in the request.

    • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

  • :requested_terms (required, Array<Types::RequestedTerm>) —

    A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

  • :source_agreement_identifier (String) —

    The agreement's identifier that the request acts upon.

    This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE). Don't provide this parameter if the intent is NEW.

  • :agreement_proposal_identifier (String) —

    The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.

    This parameter is required if the intent is not AMEND.

  • :tax_configuration (Types::TaxConfiguration) —

    Configuration for tax estimation in the agreement request response.

Returns:

See Also:



1013
1014
1015
1016
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 1013

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

#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. #=> String
resp.proposer. #=> 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:

See Also:



1065
1066
1067
1068
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 1065

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

#get_agreement_cancellation_request(params = {}) ⇒ Types::GetAgreementCancellationRequestOutput

Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.

Examples:

Example: Get a cancellation request


resp = client.get_agreement_cancellation_request({
  agreement_cancellation_request_id: "acr-sgew33rhsds", 
  agreement_id: "agmt-752jqvg74yo7k", 
})

resp.to_h outputs the following:
{
  agreement_cancellation_request_id: "acr-sgew33rhsds", 
  agreement_id: "agmt-752jqvg74yo7k", 
  created_at: Time.parse("2025-01-15T10:30:00Z"), 
  description: "Product is being discontinued and no longer supported", 
  reason_code: "PRODUCT_DISCONTINUED", 
  status: "VALIDATION_FAILED", 
  status_message: "Agreement is not in an active state", 
  updated_at: Time.parse("2025-01-16T10:30:00Z"), 
}

Request syntax with placeholder values


resp = client.get_agreement_cancellation_request({
  agreement_cancellation_request_id: "AgreementCancellationRequestId", # required
  agreement_id: "AgreementId", # required
})

Response structure


resp.agreement_cancellation_request_id #=> String
resp.agreement_id #=> String
resp.reason_code #=> String, one of "INCORRECT_TERMS_ACCEPTED", "REPLACING_AGREEMENT", "TEST_AGREEMENT", "ALTERNATIVE_PROCUREMENT_CHANNEL", "PRODUCT_DISCONTINUED", "UNINTENDED_RENEWAL", "BUYER_DISSATISFACTION", "OTHER"
resp.description #=> String
resp.status #=> String, one of "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED", "VALIDATION_FAILED"
resp.status_message #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :agreement_cancellation_request_id (required, String) —

    The unique identifier of the cancellation request.

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the cancellation request.

Returns:

See Also:



1135
1136
1137
1138
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 1135

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

#get_agreement_entitlements(params = {}) ⇒ Types::GetAgreementEntitlementsOutput

Obtains details about the entitlements of an agreement.

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_entitlements({
  agreement_id: "ResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agreement_entitlements #=> Array
resp.agreement_entitlements[0].resource.id #=> String
resp.agreement_entitlements[0].resource.type #=> String
resp.agreement_entitlements[0].type #=> String
resp.agreement_entitlements[0].registration_token #=> String
resp.agreement_entitlements[0].status #=> String, one of "PROVISIONED", "SCHEDULED", "PENDING", "FAILED", "DEPROVISIONED"
resp.agreement_entitlements[0].status_reason_code #=> String, one of "PROVISIONING_IN_PROGRESS", "FUTURE_START_DATE", "INVALID_PAYMENT_INSTRUMENT", "INCOMPATIBLE_CURRENCY", "ACCOUNT_SUSPENDED", "UNSUPPORTED_OPERATION", "AGREEMENT_INACTIVE", "AGREEMENT_ACTIVE", "PRODUCT_RESTRICTED"
resp.agreement_entitlements[0].license_arn #=> 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 agreement entitlements to return in the response.

  • :next_token (String) —

    A token to specify where to start pagination.

Returns:

See Also:



1183
1184
1185
1186
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 1183

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

#get_agreement_payment_request(params = {}) ⇒ Types::GetAgreementPaymentRequestOutput

Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.

The calling identity must be either the acceptor or proposer of the payment request. A ResourceNotFoundException is returned if the payment request does not exist.

Examples:

Request syntax with placeholder values


resp = client.get_agreement_payment_request({
  payment_request_id: "PaymentRequestId", # required
  agreement_id: "AgreementId", # required
})

Response structure


resp.payment_request_id #=> String
resp.agreement_id #=> String
resp.status #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED"
resp.status_message #=> String
resp.name #=> String
resp.description #=> String
resp.charge_id #=> String
resp.charge_amount #=> String
resp.currency_code #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :payment_request_id (required, String) —

    The identifier of the payment request.

  • :agreement_id (required, String) —

    The unique identifier of the agreement associated with the payment request.

Returns:

See Also:



1246
1247
1248
1249
 
# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/client.rb', line 1246

def get_agreement_payment_request(params = {}, options = {})
  req = build_request(:get_agreement_payment_request, 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.id #=> 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.id #=> String
resp.accepted_terms[0].support_term.refund_policy #=> String
resp.accepted_terms[0].renewal_term.type #=> String
resp.accepted_terms[0].renewal_term.id #=> 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.id #=> 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.id #=> 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].byol_pricing_term.id #=> String
resp.accepted_terms[0].recurring_payment_term.type #=> String
resp.accepted_terms[0].recurring_payment_term.id #=> 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.id #=> 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.id #=> 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.id #=> 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.id #=> 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.id #=> 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:

  • <