Class: Aws::PartnerCentralRevenueMeasurement::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb

Overview

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

client = Aws::PartnerCentralRevenueMeasurement::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
  • :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::PartnerCentralRevenueMeasurement::EndpointProvider) —

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



471
472
473
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_marketplace_revenue_share(params = {}) ⇒ Types::CreateMarketplaceRevenueShareOutput

Creates a new marketplace revenue share resource in the specified catalog.

Examples:

Example: Example for CreateMarketplaceRevenueShare


resp = client.create_marketplace_revenue_share({
  catalog: "AWS", 
  product_id: "prod-abc123def4567", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share/prod-abc123def4567", 
  product_id: "prod-abc123def4567", 
}

Request syntax with placeholder values


resp = client.create_marketplace_revenue_share({
  catalog: "AWS", # required, accepts AWS, Sandbox
  client_token: "ClientToken",
  product_id: "MarketplaceProductId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.product_id #=> String
resp.arn #=> String
resp.catalog #=> String, one of "AWS", "Sandbox"
resp.product_code #=> String
resp.product_name #=> String
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.revision #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to create the marketplace revenue share.

  • :client_token (String) —

    A unique token to ensure idempotency of the create request.

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

  • :product_id (required, String) —

    The AWS Marketplace product identifier for this revenue share.

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

    Tags to associate with the marketplace revenue share upon creation.

Returns:

See Also:



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

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

#create_marketplace_revenue_share_allocation(params = {}) ⇒ Types::CreateMarketplaceRevenueShareAllocationOutput

Creates a new marketplace revenue share allocation for the specified product.

Examples:

Example: Example for CreateMarketplaceRevenueShareAllocation


resp = client.create_marketplace_revenue_share_allocation({
  catalog: "AWS", 
  effective_from: "2026-07-01", 
  product_id: "prod-abc123def4567", 
  revenue_share_percent: "15.50", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567", 
  effective_from: "2026-07-01", 
  marketplace_revenue_share_allocation_id: "mrsa-abc123def4567", 
  product_id: "prod-abc123def4567", 
  revenue_share_percent: "15.50", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.create_marketplace_revenue_share_allocation({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_id: "MarketplaceProductId", # required
  client_token: "ClientToken",
  effective_from: "AllocationEffectiveDateString", # required
  effective_until: "AllocationEffectiveDateString",
  revenue_share_percent: "RevenueSharePercent", # required
})

Response structure


resp.marketplace_revenue_share_allocation_id #=> String
resp.product_id #=> String
resp.product_name #=> String
resp.arn #=> String
resp.effective_from #=> String
resp.effective_until #=> String
resp.revenue_share_percent #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.latest_marketplace_revenue_share_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to create the allocation.

  • :product_id (required, String) —

    The AWS Marketplace product identifier for the parent revenue share.

  • :client_token (String) —

    A unique token to ensure idempotency of the create request.

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

  • :effective_from (required, String) —

    The effective start date for the allocation. Must be the first day of a month.

  • :effective_until (String) —

    The effective end date for the allocation. Must be the last day of a month (YYYY-MM-DD). Omit for open-ended allocations.

  • :revenue_share_percent (required, String) —

    The revenue share percentage for this allocation.

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 643

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

#create_revenue_attribution(params = {}) ⇒ Types::CreateRevenueAttributionOutput

Creates a new revenue attribution record in the specified catalog.

Examples:

Example: Example for CreateRevenueAttribution


resp = client.create_revenue_attribution({
  catalog: "AWS", 
  name: "My Revenue Attribution", 
  tenancy_model: "MULTI_TENANT", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6", 
  id: "ra-0a1b2c3d4e5f6", 
  tenancy_model: "MULTI_TENANT", 
}

Request syntax with placeholder values


resp = client.create_revenue_attribution({
  catalog: "AWS", # required, accepts AWS, Sandbox
  client_token: "ClientToken",
  name: "CreateRevenueAttributionInputNameString", # required
  description: "CreateRevenueAttributionInputDescriptionString",
  tenancy_model: "MULTI_TENANT", # required, accepts MULTI_TENANT, SINGLE_TENANT
  product_identifier: "CreateRevenueAttributionInputProductIdentifierString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.tenancy_model #=> String, one of "MULTI_TENANT", "SINGLE_TENANT"
resp.marketplace_product.product_id #=> String
resp.marketplace_product.product_code #=> String
resp.marketplace_product.product_name #=> String
resp.revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog in which to create the revenue attribution.

  • :client_token (String) —

    A unique token to ensure idempotency of the create request.

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

  • :name (required, String) —

    The name of the revenue attribution. Must be unique within the catalog and the partner's account.

  • :description (String) —

    A description of the revenue attribution.

  • :tenancy_model (required, String) —

    The tenancy model for this revenue attribution.

  • :product_identifier (String) —

    The unique product identifier in AWS Marketplace. Accepts a product entity ID (e.g., prod-abc123def4567) or a product ARN.

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

    Tags to associate with the revenue attribution upon creation.

Returns:

See Also:



735
736
737
738
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 735

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

#get_marketplace_revenue_share(params = {}) ⇒ Types::GetMarketplaceRevenueShareOutput

Retrieves the details of a specific marketplace revenue share.

Examples:

Example: Example for GetMarketplaceRevenueShare


resp = client.get_marketplace_revenue_share({
  catalog: "AWS", 
  product_id: "prod-abc123def4567", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share/prod-abc123def4567", 
  catalog: "AWS", 
  product_id: "prod-abc123def4567", 
}

Request syntax with placeholder values


resp = client.get_marketplace_revenue_share({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_id: "MarketplaceProductId", # required
  revision: 1,
})

Response structure


resp.product_id #=> String
resp.arn #=> String
resp.catalog #=> String, one of "AWS", "Sandbox"
resp.product_code #=> String
resp.product_name #=> String
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.revision #=> Integer
resp.latest_revision #=> Integer
resp.total_active_marketplace_revenue_share_allocation_count #=> Integer
resp.total_marketplace_revenue_share_allocation_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that the marketplace revenue share belongs to.

  • :product_id (required, String) —

    The AWS Marketplace product identifier of the revenue share to retrieve.

  • :revision (Integer) —

    The revision of the marketplace revenue share to retrieve. Omit to return the latest revision.

Returns:

See Also:



808
809
810
811
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 808

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

#get_marketplace_revenue_share_allocation(params = {}) ⇒ Types::GetMarketplaceRevenueShareAllocationOutput

Retrieves the details of a specific marketplace revenue share allocation.

Examples:

Example: Example for GetMarketplaceRevenueShareAllocation


resp = client.get_marketplace_revenue_share_allocation({
  catalog: "AWS", 
  marketplace_revenue_share_allocation_id: "mrsa-abc123def4567", 
  product_id: "prod-abc123def4567", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567", 
  effective_from: "2026-07-01", 
  marketplace_revenue_share_allocation_id: "mrsa-abc123def4567", 
  product_id: "prod-abc123def4567", 
  revenue_share_percent: "15.50", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.get_marketplace_revenue_share_allocation({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_id: "MarketplaceProductId", # required
  marketplace_revenue_share_allocation_id: "MarketplaceRevenueShareAllocationId", # required
  marketplace_revenue_share_revision: "RevisionToken",
})

Response structure


resp.marketplace_revenue_share_allocation_id #=> String
resp.product_id #=> String
resp.product_name #=> String
resp.arn #=> String
resp.effective_from #=> String
resp.effective_until #=> String
resp.revenue_share_percent #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.latest_marketplace_revenue_share_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that the allocation belongs to.

  • :product_id (required, String) —

    The AWS Marketplace product identifier of the parent revenue share.

  • :marketplace_revenue_share_allocation_id (required, String) —

    The unique identifier of the allocation to retrieve.

  • :marketplace_revenue_share_revision (String) —

    The revision of the parent marketplace revenue share at which to retrieve the allocation. Omit to return the latest.

Returns:

See Also:



889
890
891
892
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 889

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

#get_revenue_attribution(params = {}) ⇒ Types::GetRevenueAttributionOutput

Retrieves the details of a specific revenue attribution.

Examples:

Example: Example for GetRevenueAttribution


resp = client.get_revenue_attribution({
  catalog: "AWS", 
  identifier: "ra-0a1b2c3d4e5f6", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6", 
  catalog: "AWS", 
  id: "ra-0a1b2c3d4e5f6", 
  tenancy_model: "MULTI_TENANT", 
}

Request syntax with placeholder values


resp = client.get_revenue_attribution({
  catalog: "AWS", # required, accepts AWS, Sandbox
  identifier: "RevenueAttributionIdentifier", # required
  revision: "RevisionToken",
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.catalog #=> String, one of "AWS", "Sandbox"
resp.name #=> String
resp.description #=> String
resp.tenancy_model #=> String, one of "MULTI_TENANT", "SINGLE_TENANT"
resp.marketplace_product.product_id #=> String
resp.marketplace_product.product_code #=> String
resp.marketplace_product.product_name #=> String
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.revision #=> String
resp.latest_revision #=> String
resp.effective_from #=> String
resp.effective_until #=> String
resp.total_active_revenue_attribution_allocation_count #=> Integer
resp.total_revenue_attribution_allocation_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that the revenue attribution belongs to.

  • :identifier (required, String) —

    The unique identifier of the revenue attribution to retrieve. Accepts a direct ID or ARN.

  • :revision (String) —

    The revision of the attribution to retrieve. Omit to return the latest revision.

Returns:

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 973

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

#get_revenue_attribution_allocation(params = {}) ⇒ Types::GetRevenueAttributionAllocationOutput

Retrieves a single allocation by its RevenueAttributionAllocationId. Supports optional point-in-time version queries.

Examples:

Example: Example for GetRevenueAttributionAllocation


resp = client.get_revenue_attribution_allocation({
  catalog: "AWS", 
  revenue_attribution_allocation_id: "alloc-abc123def4567", 
  revenue_attribution_identifier: "ra-0a1b2c3d4e5f6", 
})

resp.to_h outputs the following:
{
  created_date: Time.parse(1719792000), 
  customer_aws_account_id: "123456789012", 
  effective_from: "2026-07-01", 
  effective_until: "2026-07-31", 
  entity_identifier: "offer-abc123", 
  entity_type: "OFFER", 
  last_modified_date: Time.parse(1719792000), 
  revenue_attribution_allocation_id: "alloc-abc123def4567", 
  revenue_attribution_identifier: "ra-0a1b2c3d4e5f6", 
  revenue_attribution_latest_revision: "1", 
  revenue_attribution_revision: "1", 
  revenue_share_percent: "15.50", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.get_revenue_attribution_allocation({
  catalog: "AWS", # required, accepts AWS, Sandbox
  revenue_attribution_identifier: "RevenueAttributionIdentifier", # required
  revenue_attribution_allocation_id: "RevenueAttributionAllocationId", # required
  revenue_attribution_revision: "RevisionToken",
})

Response structure


resp.revenue_attribution_allocation_id #=> String
resp.revenue_attribution_identifier #=> String
resp.entity_type #=> String, one of "OFFER", "OPPORTUNITY"
resp.entity_identifier #=> String
resp.entity_name #=> String
resp. #=> String
resp.revenue_share_percent #=> String
resp.effective_from #=> String
resp.effective_until #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.revenue_attribution_revision #=> String
resp.revenue_attribution_latest_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that contains the resource.

  • :revenue_attribution_identifier (required, String) —

    The revenue attribution identifier.

  • :revenue_attribution_allocation_id (required, String) —

    The allocation identifier.

  • :revenue_attribution_revision (String) —

    Point-in-time revision number to query.

Returns:

See Also:



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

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

#get_revenue_attribution_allocations_task(params = {}) ⇒ Types::GetRevenueAttributionAllocationsTaskOutput

Retrieves the current status of a previously submitted allocations task. When COMPLETE, includes the latest revision. When FAILED, includes error details.

Examples:

Example: Example for GetRevenueAttributionAllocationsTask


resp = client.get_revenue_attribution_allocations_task({
  catalog: "AWS", 
  revenue_attribution_identifier: "ra-0a1b2c3d4e5f6", 
})

resp.to_h outputs the following:
{
  catalog: "AWS", 
  revenue_attribution_arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6", 
  started_at: Time.parse(1719792000), 
  status: "COMPLETE", 
  task_id: "raatask-abc123def4567", 
  total_revenue_attribution_allocation_records: 1, 
}

Request syntax with placeholder values


resp = client.get_revenue_attribution_allocations_task({
  catalog: "AWS", # required, accepts AWS, Sandbox
  revenue_attribution_identifier: "RevenueAttributionIdentifier", # required
})

Response structure


resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.catalog #=> String, one of "AWS", "Sandbox"
resp.revenue_attribution_arn #=> String
resp.started_at #=> Time
resp.ended_at #=> Time
resp.total_revenue_attribution_allocation_records #=> Integer
resp.description #=> String
resp.revenue_attribution_latest_revision #=> String
resp.error_detail_list #=> Array
resp.error_detail_list[0].revenue_attribution_allocation_id #=> String
resp.error_detail_list[0].entity_type #=> String, one of "OFFER", "OPPORTUNITY"
resp.error_detail_list[0].entity_id #=> String
resp.error_detail_list[0]. #=> String
resp.error_detail_list[0].effective_from #=> String
resp.error_detail_list[0].effective_until #=> String
resp.error_detail_list[0].action #=> String, one of "CREATE", "UPDATE"
resp.error_detail_list[0].error_code #=> String, one of "ALLOCATION_CAP_EXCEEDED", "RESOURCE_NOT_FOUND", "IMMUTABLE_ALLOCATION", "ACCESS_DENIED", "INVALID_VALUE", "CONCURRENT_MODIFICATION", "INTERNAL_ERROR"
resp.error_detail_list[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that contains the resource.

  • :revenue_attribution_identifier (required, String) —

    The revenue attribution identifier.

Returns:

See Also:



1145
1146
1147
1148
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1145

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

#list_marketplace_revenue_share_allocations(params = {}) ⇒ Types::ListMarketplaceRevenueShareAllocationsOutput

Returns a paginated list of allocations under a marketplace revenue share, with optional filtering by status and effective date range. Supports historical reads at a specific share revision.

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

Examples:

Example: Example for ListMarketplaceRevenueShareAllocations


resp = client.list_marketplace_revenue_share_allocations({
  catalog: "AWS", 
  product_id: "prod-abc123def4567", 
})

resp.to_h outputs the following:
{
  marketplace_revenue_share_allocation_summaries: [
  ], 
}

Request syntax with placeholder values


resp = client.list_marketplace_revenue_share_allocations({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_id: "MarketplaceProductId", # required
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  after_effective_from: "AllocationEffectiveDateString",
  before_effective_from: "AllocationEffectiveDateString",
  sort_by: "EffectiveFrom", # accepts EffectiveFrom
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "NextToken",
  marketplace_revenue_share_revision: "RevisionToken",
})

Response structure


resp.marketplace_revenue_share_allocation_summaries #=> Array
resp.marketplace_revenue_share_allocation_summaries[0].marketplace_revenue_share_allocation_id #=> String
resp.marketplace_revenue_share_allocation_summaries[0].product_id #=> String
resp.marketplace_revenue_share_allocation_summaries[0].product_name #=> String
resp.marketplace_revenue_share_allocation_summaries[0].arn #=> String
resp.marketplace_revenue_share_allocation_summaries[0].effective_from #=> String
resp.marketplace_revenue_share_allocation_summaries[0].effective_until #=> String
resp.marketplace_revenue_share_allocation_summaries[0].revenue_share_percent #=> String
resp.marketplace_revenue_share_allocation_summaries[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.marketplace_revenue_share_allocation_summaries[0].created_date #=> Time
resp.marketplace_revenue_share_allocation_summaries[0].last_modified_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog containing the allocations.

  • :product_id (required, String) —

    The AWS Marketplace product identifier for the parent revenue share.

  • :status (String) —

    Filter by allocation status.

  • :after_effective_from (String) —

    Inclusive lower bound for EffectiveFrom date filter.

  • :before_effective_from (String) —

    Exclusive upper bound for EffectiveFrom date filter (half-open range).

  • :sort_by (String) —

    The field to sort marketplace revenue share allocations by.

  • :sort_order (String) —

    The direction to sort results. Defaults to DESCENDING.

  • :max_results (Integer) —

    Maximum number of results per page.

  • :next_token (String) —

    Pagination token from a previous response.

  • :marketplace_revenue_share_revision (String) —

    Optional share revision for historical list. Returns allocations as they existed at this revision.

Returns:

See Also:



1240
1241
1242
1243
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1240

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

#list_marketplace_revenue_shares(params = {}) ⇒ Types::ListMarketplaceRevenueSharesOutput

Returns a paginated list of marketplace revenue shares with optional filters.

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

Examples:

Example: Example for ListMarketplaceRevenueShares


resp = client.list_marketplace_revenue_shares({
  catalog: "AWS", 
  max_results: 10, 
})

resp.to_h outputs the following:
{
  marketplace_revenue_share_summaries: [
  ], 
}

Request syntax with placeholder values


resp = client.list_marketplace_revenue_shares({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_ids: ["MarketplaceProductId"],
  product_codes: ["String"],
  max_results: 1,
  next_token: "NextToken",
  sort_by: "LastModifiedDate", # accepts LastModifiedDate
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  created_after: Time.now,
  created_before: Time.now,
})

Response structure


resp.marketplace_revenue_share_summaries #=> Array
resp.marketplace_revenue_share_summaries[0].product_id #=> String
resp.marketplace_revenue_share_summaries[0].arn #=> String
resp.marketplace_revenue_share_summaries[0].catalog #=> String, one of "AWS", "Sandbox"
resp.marketplace_revenue_share_summaries[0].product_code #=> String
resp.marketplace_revenue_share_summaries[0].product_name #=> String
resp.marketplace_revenue_share_summaries[0].created_date #=> Time
resp.marketplace_revenue_share_summaries[0].last_modified_date #=> Time
resp.marketplace_revenue_share_summaries[0].latest_revision #=> Integer
resp.marketplace_revenue_share_summaries[0].total_active_marketplace_revenue_share_allocation_count #=> Integer
resp.marketplace_revenue_share_summaries[0].total_marketplace_revenue_share_allocation_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog to list marketplace revenue shares from.

  • :product_ids (Array<String>) —

    Filter results to only include shares with these product identifiers.

  • :product_codes (Array<String>) —

    Filter results to only include shares with these product codes.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    Token for pagination. Use the value returned in the previous response to retrieve the next page.

  • :sort_by (String) —

    The field to sort marketplace revenue shares by.

  • :sort_order (String) —

    The direction to sort results.

  • :created_after (Time, DateTime, Date, Integer, String) —

    Filter results to only include marketplace revenue shares created after this timestamp.

  • :created_before (Time, DateTime, Date, Integer, String) —

    Filter results to only include marketplace revenue shares created before this timestamp.

Returns:

See Also:



1332
1333
1334
1335
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1332

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

#list_revenue_attribution_allocations(params = {}) ⇒ Types::ListRevenueAttributionAllocationsOutput

Returns a paginated list of committed allocations with support for filtering by entity, customer, status, or date range.

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

Examples:

Example: Example for ListRevenueAttributionAllocations


resp = client.list_revenue_attribution_allocations({
  catalog: "AWS", 
  revenue_attribution_identifier: "ra-0a1b2c3d4e5f6", 
})

resp.to_h outputs the following:
{
  revenue_attribution_allocation_summaries: [
  ], 
}

Request syntax with placeholder values


resp = client.list_revenue_attribution_allocations({
  catalog: "AWS", # required, accepts AWS, Sandbox
  revenue_attribution_identifier: "RevenueAttributionIdentifier", # required
  entity_type_filters: ["OFFER"], # accepts OFFER, OPPORTUNITY
  entity_identifier_filters: ["EntityIdentifier"],
  customer_aws_account_id_filters: ["CustomerAwsAccountId"],
  status_filter: "ACTIVE", # accepts ACTIVE, INACTIVE
  after_effective_from: "AllocationEffectiveDateString",
  before_effective_from: "AllocationEffectiveDateString",
  after_effective_until: "AllocationEffectiveDateString",
  before_effective_until: "AllocationEffectiveDateString",
  sort_by: "EffectiveFrom", # accepts EffectiveFrom
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  revenue_attribution_revision: "RevisionToken",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.revenue_attribution_allocation_summaries #=> Array
resp.revenue_attribution_allocation_summaries[0].revenue_attribution_allocation_id #=> String
resp.revenue_attribution_allocation_summaries[0].revenue_attribution_identifier #=> String
resp.revenue_attribution_allocation_summaries[0].entity_type #=> String, one of "OFFER", "OPPORTUNITY"
resp.revenue_attribution_allocation_summaries[0].entity_identifier #=> String
resp.revenue_attribution_allocation_summaries[0].entity_name #=> String
resp.revenue_attribution_allocation_summaries[0]. #=> String
resp.revenue_attribution_allocation_summaries[0].revenue_share_percent #=> String
resp.revenue_attribution_allocation_summaries[0].effective_from #=> String
resp.revenue_attribution_allocation_summaries[0].effective_until #=> String
resp.revenue_attribution_allocation_summaries[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that contains the resource.

  • :revenue_attribution_identifier (required, String) —

    The revenue attribution identifier to query.

  • :entity_type_filters (Array<String>) —

    Filter by deal entity types.

  • :entity_identifier_filters (Array<String>) —

    Filter by deal entity identifiers.

  • :customer_aws_account_id_filters (Array<String>) —

    Filter by customer AWS account IDs for associated deal entities.

  • :status_filter (String) —

    Filter by allocation status.

  • :after_effective_from (String) —

    Inclusive lower bound for EffectiveFrom date filter.

  • :before_effective_from (String) —

    Exclusive upper bound for EffectiveFrom date filter (half-open range).

  • :after_effective_until (String) —

    Inclusive lower bound for EffectiveUntil date filter.

  • :before_effective_until (String) —

    Exclusive upper bound for EffectiveUntil date filter (half-open range).

  • :sort_by (String) —

    Field to sort by.

  • :sort_order (String) —

    Sort direction. Defaults to ASCENDING.

  • :revenue_attribution_revision (String) —

    Point-in-time revision number to query.

  • :max_results (Integer) —

    Maximum results per page.

  • :next_token (String) —

    Pagination token from previous response.

Returns:

See Also:



1446
1447
1448
1449
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1446

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

#list_revenue_attributions(params = {}) ⇒ Types::ListRevenueAttributionsOutput

Returns a paginated list of revenue attributions with optional filters.

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

Examples:

Example: Example for ListRevenueAttributions


resp = client.list_revenue_attributions({
  catalog: "AWS", 
})

resp.to_h outputs the following:
{
  revenue_attribution_summaries: [
  ], 
}

Request syntax with placeholder values


resp = client.list_revenue_attributions({
  catalog: "AWS", # required, accepts AWS, Sandbox
  identifiers: ["RevenueAttributionIdentifier"],
  created_after: Time.now,
  created_before: Time.now,
  sort_by: "LastModifiedDate", # accepts LastModifiedDate
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.revenue_attribution_summaries #=> Array
resp.revenue_attribution_summaries[0].arn #=> String
resp.revenue_attribution_summaries[0].id #=> String
resp.revenue_attribution_summaries[0].catalog #=> String, one of "AWS", "Sandbox"
resp.revenue_attribution_summaries[0].name #=> String
resp.revenue_attribution_summaries[0].tenancy_model #=> String, one of "MULTI_TENANT", "SINGLE_TENANT"
resp.revenue_attribution_summaries[0].marketplace_product.product_id #=> String
resp.revenue_attribution_summaries[0].marketplace_product.product_code #=> String
resp.revenue_attribution_summaries[0].marketplace_product.product_name #=> String
resp.revenue_attribution_summaries[0].created_date #=> Time
resp.revenue_attribution_summaries[0].last_modified_date #=> Time
resp.revenue_attribution_summaries[0].latest_revision #=> String
resp.revenue_attribution_summaries[0].effective_from #=> String
resp.revenue_attribution_summaries[0].effective_until #=> String
resp.revenue_attribution_summaries[0].total_active_revenue_attribution_allocation_count #=> Integer
resp.revenue_attribution_summaries[0].total_revenue_attribution_allocation_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog to list revenue attributions from.

  • :identifiers (Array<String>) —

    Filter results to only include revenue attributions with the specified identifiers.

  • :created_after (Time, DateTime, Date, Integer, String) —

    Filter results to only include revenue attributions created after this timestamp.

  • :created_before (Time, DateTime, Date, Integer, String) —

    Filter results to only include revenue attributions created before this timestamp.

  • :sort_by (String) —

    The field to sort revenue attributions by.

  • :sort_order (String) —

    The direction to sort results.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    Token for pagination. Use the value returned in the previous response to retrieve the next page.

Returns:

See Also:



1539
1540
1541
1542
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1539

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

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

Returns the tags associated with the specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

    The Amazon Resource Name (ARN) of the resource to list tags for.

Returns:

See Also:



1569
1570
1571
1572
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1569

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

#start_revenue_attribution_allocations_task(params = {}) ⇒ Types::StartRevenueAttributionAllocationsTaskOutput

Submits a batch of up to 250 allocation changes (CREATE and/or UPDATE) for asynchronous processing. Returns a TaskId for tracking.

Examples:

Example: Example for StartRevenueAttributionAllocationsTask


resp = client.start_revenue_attribution_allocations_task({
  catalog: "AWS", 
  client_token: "unique-token-123", 
  revenue_attribution_identifier: "ra-0a1b2c3d4e5f6", 
  revenue_attribution_revision: "1", 
  revenue_share_allocations: [
    {
      action: "CREATE", 
      customer_aws_account_id: "123456789012", 
      effective_from: "2026-07-01", 
      effective_until: "2026-07-31", 
      entity_identifier: "offer-abc123", 
      entity_type: "OFFER", 
      revenue_share_percent: "15.50", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  catalog: "AWS", 
  revenue_attribution_arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6", 
  started_at: Time.parse(1719792000), 
  status: "IN_PROGRESS", 
  task_id: "raatask-abc123def4567", 
  total_revenue_attribution_allocation_records: 1, 
}

Request syntax with placeholder values


resp = client.start_revenue_attribution_allocations_task({
  catalog: "AWS", # required, accepts AWS, Sandbox
  revenue_attribution_identifier: "RevenueAttributionIdentifier", # required
  revenue_attribution_revision: "RevisionToken", # required
  revenue_share_allocations: [ # required
    {
      action: "CREATE", # required, accepts CREATE, UPDATE
      revenue_attribution_allocation_id: "RevenueAttributionAllocationId",
      entity_type: "OFFER", # required, accepts OFFER, OPPORTUNITY
      entity_identifier: "EntityIdentifier", # required
      customer_aws_account_id: "CustomerAwsAccountId", # required
      revenue_share_percent: "RevenueSharePercent", # required
      effective_from: "AllocationEffectiveDateString", # required
      effective_until: "AllocationEffectiveDateString", # required
      status: "ACTIVE", # accepts ACTIVE, INACTIVE
    },
  ],
  client_token: "ClientToken",
  description: "StartRevenueAttributionAllocationsTaskInputDescriptionString",
})

Response structure


resp.task_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"
resp.catalog #=> String, one of "AWS", "Sandbox"
resp.revenue_attribution_arn #=> String
resp.started_at #=> Time
resp.total_revenue_attribution_allocation_records #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog context for this operation.

  • :revenue_attribution_identifier (required, String) —

    The revenue attribution identifier.

  • :revenue_attribution_revision (required, String) —

    Current revision of the revenue attribution for optimistic locking.

  • :revenue_share_allocations (required, Array<Types::RevenueShareAllocation>) —

    The list of allocation changes to process in this batch.

  • :client_token (String) —

    Idempotency token for deduplication and retry.

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

  • :description (String) —

    Human-readable description of the batch.

Returns:

See Also:



1674
1675
1676
1677
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1674

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

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites one or more tags for the specified resource.

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

    The Amazon Resource Name (ARN) of the resource to tag.

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

    The tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1705
1706
1707
1708
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1705

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

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

    The Amazon Resource Name (ARN) of the resource to remove tags from.

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

    The tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1731
1732
1733
1734
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1731

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

#update_marketplace_revenue_share_allocation(params = {}) ⇒ Types::UpdateMarketplaceRevenueShareAllocationOutput

Updates an existing marketplace revenue share allocation. Supports modifying effective dates, revenue share percentage, and status with time-based mutability rules.

Examples:

Example: Example for UpdateMarketplaceRevenueShareAllocation


resp = client.update_marketplace_revenue_share_allocation({
  catalog: "AWS", 
  marketplace_revenue_share_allocation_id: "mrsa-abc123def4567", 
  marketplace_revenue_share_revision: "1", 
  product_id: "prod-abc123def4567", 
  revenue_share_percent: "20.00", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/marketplace-revenue-share-allocation/mrsa-abc123def4567", 
  effective_from: "2026-07-01", 
  marketplace_revenue_share_allocation_id: "mrsa-abc123def4567", 
  product_id: "prod-abc123def4567", 
  revenue_share_percent: "20.00", 
  status: "ACTIVE", 
}

Request syntax with placeholder values


resp = client.update_marketplace_revenue_share_allocation({
  catalog: "AWS", # required, accepts AWS, Sandbox
  product_id: "MarketplaceProductId", # required
  marketplace_revenue_share_allocation_id: "MarketplaceRevenueShareAllocationId", # required
  marketplace_revenue_share_revision: "RevisionToken", # required
  client_token: "ClientToken",
  effective_from: "AllocationEffectiveDateString",
  effective_until: "AllocationEffectiveDateString",
  revenue_share_percent: "RevenueSharePercent",
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
})

Response structure


resp.marketplace_revenue_share_allocation_id #=> String
resp.product_id #=> String
resp.product_name #=> String
resp.arn #=> String
resp.effective_from #=> String
resp.effective_until #=> String
resp.revenue_share_percent #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE"
resp.created_date #=> Time
resp.last_modified_date #=> Time
resp.latest_marketplace_revenue_share_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog containing the allocation.

  • :product_id (required, String) —

    The AWS Marketplace product identifier for the parent revenue share.

  • :marketplace_revenue_share_allocation_id (required, String) —

    The identifier of the allocation to update.

  • :marketplace_revenue_share_revision (required, String) —

    The current revision of the parent share. Must match for optimistic concurrency control.

  • :client_token (String) —

    A unique token to ensure idempotency of the update request.

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

  • :effective_from (String) —

    The new effective start date. Must be the first day of a month. Only modifiable on future-dated allocations.

  • :effective_until (String) —

    The new effective end date. Must be the last day of a month and on or after today.

  • :revenue_share_percent (String) —

    The new revenue share percentage. Only modifiable on future-dated allocations.

  • :status (String) —

    The new status. Set to INACTIVE for soft-delete. Only modifiable on future-dated allocations.

Returns:

See Also:



1842
1843
1844
1845
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1842

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

#update_revenue_attribution(params = {}) ⇒ Types::UpdateRevenueAttributionOutput

Updates an existing revenue attribution record.

Examples:

Example: Example for UpdateRevenueAttribution


resp = client.update_revenue_attribution({
  catalog: "AWS", 
  identifier: "ra-0a1b2c3d4e5f6", 
  revision: "1", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:partnercentral:us-east-1:123456789012:catalog/AWS/revenue-attribution/ra-0a1b2c3d4e5f6", 
  id: "ra-0a1b2c3d4e5f6", 
  last_modified_date: Time.parse(1719792000), 
}

Request syntax with placeholder values


resp = client.update_revenue_attribution({
  catalog: "AWS", # required, accepts AWS, Sandbox
  identifier: "RevenueAttributionIdentifier", # required
  client_token: "ClientToken",
  description: "UpdateRevenueAttributionInputDescriptionString",
  revision: "RevisionToken", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.description #=> String
resp.last_modified_date #=> Time
resp.latest_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog that the revenue attribution belongs to.

  • :identifier (required, String) —

    The unique identifier of the revenue attribution to update. Accepts a direct ID or ARN.

  • :client_token (String) —

    A unique token to ensure idempotency of the update request.

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

  • :description (String) —

    The updated description of the revenue attribution.

  • :revision (required, String) —

    The current revision of the revenue attribution. Must match the server's current value.

Returns:

See Also:



1915
1916
1917
1918
 
# File 'gems/aws-sdk-partnercentralrevenuemeasurement/lib/aws-sdk-partnercentralrevenuemeasurement/client.rb', line 1915

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