Class: Aws::PartnerCentralBenefits::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-partnercentralbenefits/client.rb

Overview

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

client = Aws::PartnerCentralBenefits::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

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

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

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PartnerCentralBenefits::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 ‘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 'lib/aws-sdk-partnercentralbenefits/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1500
1501
1502
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1500

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1503
1504
1505
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1503

def errors_module
  Errors
end

Instance Method Details

#amend_benefit_application(params = {}) ⇒ Struct

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

Examples:

Request syntax with placeholder values


resp = client.amend_benefit_application({
  catalog: "CatalogName", # required
  client_token: "AmendBenefitApplicationInputClientTokenString", # required
  revision: "String", # required
  identifier: "BenefitApplicationIdentifier", # required
  amendment_reason: "AmendBenefitApplicationInputAmendmentReasonString", # required
  amendments: [ # required
    {
      field_path: "String", # required
      new_value: "String", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.

  • :revision (required, String) —

    The current revision number of the benefit application to ensure optimistic concurrency control.

  • :identifier (required, String) —

    The unique identifier of the benefit application to be amended.

  • :amendment_reason (required, String) —

    A descriptive reason explaining why the benefit application is being amended.

  • :amendments (required, Array<Types::Amendment>) —

    A list of specific field amendments to apply to the benefit application.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



532
533
534
535
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 532

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

#associate_benefit_application_resource(params = {}) ⇒ Types::AssociateBenefitApplicationResourceOutput

Links an AWS resource to an existing benefit application for tracking and management purposes.

Examples:

Request syntax with placeholder values


resp = client.associate_benefit_application_resource({
  catalog: "CatalogName", # required
  benefit_application_identifier: "BenefitApplicationIdentifier", # required
  resource_arn: "AssociateBenefitApplicationResourceInputResourceArnString", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :benefit_application_identifier (required, String) —

    The unique identifier of the benefit application to associate the resource with.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.

Returns:

See Also:



576
577
578
579
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 576

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1473

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PartnerCentralBenefits')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-partnercentralbenefits'
  context[:gem_version] = '1.7.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_benefit_application(params = {}) ⇒ Struct

Cancels a benefit application that is currently in progress, preventing further processing.

Examples:

Request syntax with placeholder values


resp = client.cancel_benefit_application({
  catalog: "CatalogName", # required
  client_token: "CancelBenefitApplicationInputClientTokenString", # required
  identifier: "BenefitApplicationIdentifier", # required
  reason: "CancelBenefitApplicationInputReasonString",
})

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.

  • :identifier (required, String) —

    The unique identifier of the benefit application to cancel.

  • :reason (String) —

    A descriptive reason explaining why the benefit application is being cancelled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



614
615
616
617
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 614

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

#create_benefit_application(params = {}) ⇒ Types::CreateBenefitApplicationOutput

Creates a new benefit application for a partner to request access to AWS benefits and programs.

Examples:

Request syntax with placeholder values


resp = client.create_benefit_application({
  catalog: "CatalogName", # required
  client_token: "CreateBenefitApplicationInputClientTokenString", # required
  name: "BenefitApplicationName",
  description: "BenefitApplicationDescription",
  benefit_identifier: "CreateBenefitApplicationInputBenefitIdentifierString", # required
  fulfillment_types: ["CREDITS"], # accepts CREDITS, CASH, ACCESS
  benefit_application_details: {
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  associated_resources: ["Arn"],
  partner_contacts: [
    {
      email: "ContactEmail",
      first_name: "ContactFirstName",
      last_name: "ContactLastName",
      business_title: "ContactBusinessTitleString",
      phone: "ContactPhone",
    },
  ],
  file_details: [
    {
      file_uri: "FileURI", # required
      business_use_case: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog to create the application in.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure idempotent processing of the creation request.

  • :name (String) —

    A human-readable name for the benefit application.

  • :description (String) —

    A detailed description of the benefit application and its intended use.

  • :benefit_identifier (required, String) —

    The unique identifier of the benefit being requested in this application.

  • :fulfillment_types (Array<String>) —

    The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

  • :benefit_application_details (Hash, Array, String, Numeric, Boolean) —

    Detailed information and requirements specific to the benefit being requested.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

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

    Key-value pairs to categorize and organize the benefit application.

  • :associated_resources (Array<String>) —

    AWS resources that are associated with this benefit application.

  • :partner_contacts (Array<Types::Contact>) —

    Contact information for partner representatives responsible for this benefit application.

  • :file_details (Array<Types::FileInput>) —

    Supporting documents and files attached to the benefit application.

Returns:

See Also:



718
719
720
721
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 718

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

#disassociate_benefit_application_resource(params = {}) ⇒ Types::DisassociateBenefitApplicationResourceOutput

Removes the association between an AWS resource and a benefit application.

Examples:

Request syntax with placeholder values


resp = client.disassociate_benefit_application_resource({
  catalog: "CatalogName", # required
  benefit_application_identifier: "BenefitApplicationIdentifier", # required
  resource_arn: "DisassociateBenefitApplicationResourceInputResourceArnString", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :benefit_application_identifier (required, String) —

    The unique identifier of the benefit application to disassociate the resource from.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.

Returns:

See Also:



762
763
764
765
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 762

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

#get_benefit(params = {}) ⇒ Types::GetBenefitOutput

Retrieves detailed information about a specific benefit available in the partner catalog.

Examples:

Request syntax with placeholder values


resp = client.get_benefit({
  catalog: "CatalogName", # required
  identifier: "GetBenefitInputIdentifierString", # required
})

Response structure


resp.id #=> String
resp.catalog #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.programs #=> Array
resp.programs[0] #=> String
resp.fulfillment_types #=> Array
resp.fulfillment_types[0] #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.status #=> String, one of "ACTIVE", "INACTIVE"

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog to query.

  • :identifier (required, String) —

    The unique identifier of the benefit to retrieve.

Returns:

See Also:



812
813
814
815
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 812

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

#get_benefit_allocation(params = {}) ⇒ Types::GetBenefitAllocationOutput

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

Examples:

Request syntax with placeholder values


resp = client.get_benefit_allocation({
  catalog: "CatalogName", # required
  identifier: "BenefitAllocationIdentifier", # required
})

Response structure


resp.id #=> String
resp.catalog #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE", "FULFILLED"
resp.status_reason #=> String
resp.benefit_application_id #=> String
resp.benefit_id #=> String
resp.fulfillment_type #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.applicable_benefit_ids #=> Array
resp.applicable_benefit_ids[0] #=> String
resp.fulfillment_detail.disbursement_details.disbursed_amount.amount #=> String
resp.fulfillment_detail.disbursement_details.disbursed_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.disbursement_details.issuance_details.issuance_id #=> String
resp.fulfillment_detail.disbursement_details.issuance_details.issuance_amount.amount #=> String
resp.fulfillment_detail.disbursement_details.issuance_details.issuance_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.disbursement_details.issuance_details.issued_at #=> Time
resp.fulfillment_detail.consumable_details.allocated_amount.amount #=> String
resp.fulfillment_detail.consumable_details.allocated_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.consumable_details.remaining_amount.amount #=> String
resp.fulfillment_detail.consumable_details.remaining_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.consumable_details.utilized_amount.amount #=> String
resp.fulfillment_detail.consumable_details.utilized_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.consumable_details.issuance_details.issuance_id #=> String
resp.fulfillment_detail.consumable_details.issuance_details.issuance_amount.amount #=> String
resp.fulfillment_detail.consumable_details.issuance_details.issuance_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.consumable_details.issuance_details.issued_at #=> Time
resp.fulfillment_detail.credit_details.allocated_amount.amount #=> String
resp.fulfillment_detail.credit_details.allocated_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.credit_details.issued_amount.amount #=> String
resp.fulfillment_detail.credit_details.issued_amount.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.credit_details.codes #=> Array
resp.fulfillment_detail.credit_details.codes[0]. #=> String
resp.fulfillment_detail.credit_details.codes[0].value.amount #=> String
resp.fulfillment_detail.credit_details.codes[0].value.currency_code #=> String, one of "AED", "AMD", "ARS", "AUD", "AWG", "AZN", "BBD", "BDT", "BGN", "BMD", "BND", "BOB", "BRL", "BSD", "BYR", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "EEK", "EGP", "EUR", "GBP", "GEL", "GHS", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KES", "KHR", "KRW", "KYD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MNT", "MOP", "MUR", "MVR", "MXN", "MYR", "NAD", "NGN", "NIO", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RUB", "SAR", "SEK", "SGD", "SIT", "SKK", "THB", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "USD", "UYU", "UZS", "VND", "XAF", "XCD", "XOF", "XPF", "ZAR"
resp.fulfillment_detail.credit_details.codes[0].aws_credit_code #=> String
resp.fulfillment_detail.credit_details.codes[0].status #=> String, one of "ACTIVE", "INACTIVE", "FULFILLED"
resp.fulfillment_detail.credit_details.codes[0].issued_at #=> Time
resp.fulfillment_detail.credit_details.codes[0].expires_at #=> Time
resp.fulfillment_detail.access_details.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.starts_at #=> Time
resp.expires_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog to query.

  • :identifier (required, String) —

    The unique identifier of the benefit allocation to retrieve.

Returns:

See Also:



904
905
906
907
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 904

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

#get_benefit_application(params = {}) ⇒ Types::GetBenefitApplicationOutput

Retrieves detailed information about a specific benefit application.

Examples:

Request syntax with placeholder values


resp = client.get_benefit_application({
  catalog: "CatalogName", # required
  identifier: "BenefitApplicationIdentifier", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.catalog #=> String
resp.benefit_id #=> String
resp.name #=> String
resp.description #=> String
resp.fulfillment_types #=> Array
resp.fulfillment_types[0] #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.programs #=> Array
resp.programs[0] #=> String
resp.status #=> String, one of "PENDING_SUBMISSION", "IN_REVIEW", "ACTION_REQUIRED", "APPROVED", "REJECTED", "CANCELED"
resp.stage #=> String
resp.status_reason #=> String
resp.status_reason_code #=> String
resp.status_reason_codes #=> Array
resp.status_reason_codes[0] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.revision #=> String
resp.associated_resources #=> Array
resp.associated_resources[0] #=> String
resp.partner_contacts #=> Array
resp.partner_contacts[0].email #=> String
resp.partner_contacts[0].first_name #=> String
resp.partner_contacts[0].last_name #=> String
resp.partner_contacts[0].business_title #=> String
resp.partner_contacts[0].phone #=> String
resp.file_details #=> Array
resp.file_details[0].file_uri #=> String
resp.file_details[0].business_use_case #=> String
resp.file_details[0].file_name #=> String
resp.file_details[0].file_status #=> String
resp.file_details[0].file_status_reason #=> String
resp.file_details[0].file_type #=> String, one of "application/msword", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "application/pdf", "image/png", "image/jpeg", "image/svg+xml", "text/csv"
resp.file_details[0].created_by #=> String
resp.file_details[0].created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog to query.

  • :identifier (required, String) —

    The unique identifier of the benefit application to retrieve.

Returns:

See Also:



990
991
992
993
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 990

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

#list_benefit_allocations(params = {}) ⇒ Types::ListBenefitAllocationsOutput

Retrieves a paginated list of benefit allocations based on specified filter criteria.

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

Examples:

Request syntax with placeholder values


resp = client.list_benefit_allocations({
  catalog: "CatalogName", # required
  fulfillment_types: ["CREDITS"], # accepts CREDITS, CASH, ACCESS
  benefit_identifiers: ["BenefitId"],
  benefit_application_identifiers: ["BenefitApplicationIdentifier"],
  status: ["ACTIVE"], # accepts ACTIVE, INACTIVE, FULFILLED
  max_results: 1,
  next_token: "ListBenefitAllocationsInputNextTokenString",
})

Response structure


resp.benefit_allocation_summaries #=> Array
resp.benefit_allocation_summaries[0].id #=> String
resp.benefit_allocation_summaries[0].catalog #=> String
resp.benefit_allocation_summaries[0].arn #=> String
resp.benefit_allocation_summaries[0].status #=> String, one of "ACTIVE", "INACTIVE", "FULFILLED"
resp.benefit_allocation_summaries[0].status_reason #=> String
resp.benefit_allocation_summaries[0].name #=> String
resp.benefit_allocation_summaries[0].benefit_id #=> String
resp.benefit_allocation_summaries[0].benefit_application_id #=> String
resp.benefit_allocation_summaries[0].fulfillment_types #=> Array
resp.benefit_allocation_summaries[0].fulfillment_types[0] #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.benefit_allocation_summaries[0].created_at #=> Time
resp.benefit_allocation_summaries[0].expires_at #=> Time
resp.benefit_allocation_summaries[0].applicable_benefit_ids #=> Array
resp.benefit_allocation_summaries[0].applicable_benefit_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier to filter benefit allocations by catalog.

  • :fulfillment_types (Array<String>) —

    Filter benefit allocations by specific fulfillment types.

  • :benefit_identifiers (Array<String>) —

    Filter benefit allocations by specific benefit identifiers.

  • :benefit_application_identifiers (Array<String>) —

    Filter benefit allocations by specific benefit application identifiers.

  • :status (Array<String>) —

    Filter benefit allocations by their current status.

  • :max_results (Integer) —

    The maximum number of benefit allocations to return in a single response.

  • :next_token (String) —

    A pagination token to retrieve the next set of results from a previous request.

Returns:

See Also:



1064
1065
1066
1067
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1064

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

#list_benefit_applications(params = {}) ⇒ Types::ListBenefitApplicationsOutput

Retrieves a paginated list of benefit applications based on specified filter criteria.

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

Examples:

Request syntax with placeholder values


resp = client.list_benefit_applications({
  catalog: "CatalogName", # required
  programs: ["Program"],
  fulfillment_types: ["CREDITS"], # accepts CREDITS, CASH, ACCESS
  benefit_identifiers: ["BenefitId"],
  status: ["PENDING_SUBMISSION"], # accepts PENDING_SUBMISSION, IN_REVIEW, ACTION_REQUIRED, APPROVED, REJECTED, CANCELED
  stages: ["BenefitApplicationStage"],
  associated_resources: [
    {
      resource_type: "OPPORTUNITY", # accepts OPPORTUNITY, BENEFIT_ALLOCATION
      resource_identifier: "String",
      resource_arn: "Arn",
    },
  ],
  associated_resource_arns: ["Arn"],
  max_results: 1,
  next_token: "ListBenefitApplicationsInputNextTokenString",
})

Response structure


resp.benefit_application_summaries #=> Array
resp.benefit_application_summaries[0].catalog #=> String
resp.benefit_application_summaries[0].name #=> String
resp.benefit_application_summaries[0].id #=> String
resp.benefit_application_summaries[0].arn #=> String
resp.benefit_application_summaries[0].benefit_id #=> String
resp.benefit_application_summaries[0].programs #=> Array
resp.benefit_application_summaries[0].programs[0] #=> String
resp.benefit_application_summaries[0].fulfillment_types #=> Array
resp.benefit_application_summaries[0].fulfillment_types[0] #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.benefit_application_summaries[0].status #=> String, one of "PENDING_SUBMISSION", "IN_REVIEW", "ACTION_REQUIRED", "APPROVED", "REJECTED", "CANCELED"
resp.benefit_application_summaries[0].stage #=> String
resp.benefit_application_summaries[0].created_at #=> Time
resp.benefit_application_summaries[0].updated_at #=> Time
resp.benefit_application_summaries[0].benefit_application_details #=> Hash
resp.benefit_application_summaries[0].benefit_application_details["String"] #=> String
resp.benefit_application_summaries[0].associated_resources #=> Array
resp.benefit_application_summaries[0].associated_resources[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier to filter benefit applications by catalog.

  • :programs (Array<String>) —

    Filter benefit applications by specific AWS partner programs.

  • :fulfillment_types (Array<String>) —

    Filter benefit applications by specific fulfillment types.

  • :benefit_identifiers (Array<String>) —

    Filter benefit applications by specific benefit identifiers.

  • :status (Array<String>) —

    Filter benefit applications by their current processing status.

  • :stages (Array<String>) —

    Filter benefit applications by their current processing stage.

  • :associated_resources (Array<Types::AssociatedResource>) —

    Filter benefit applications by associated AWS resources.

  • :associated_resource_arns (Array<String>) —

    Filter benefit applications by specific AWS resource ARNs.

  • :max_results (Integer) —

    The maximum number of benefit applications to return in a single response.

  • :next_token (String) —

    A pagination token to retrieve the next set of results from a previous request.

Returns:

See Also:



1158
1159
1160
1161
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1158

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

#list_benefits(params = {}) ⇒ Types::ListBenefitsOutput

Retrieves a paginated list of available benefits based on specified filter criteria.

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

Examples:

Request syntax with placeholder values


resp = client.list_benefits({
  catalog: "CatalogName", # required
  programs: ["Program"],
  fulfillment_types: ["CREDITS"], # accepts CREDITS, CASH, ACCESS
  status: ["ACTIVE"], # accepts ACTIVE, INACTIVE
  max_results: 1,
  next_token: "ListBenefitsInputNextTokenString",
})

Response structure


resp.benefit_summaries #=> Array
resp.benefit_summaries[0].id #=> String
resp.benefit_summaries[0].catalog #=> String
resp.benefit_summaries[0].arn #=> String
resp.benefit_summaries[0].name #=> String
resp.benefit_summaries[0].description #=> String
resp.benefit_summaries[0].programs #=> Array
resp.benefit_summaries[0].programs[0] #=> String
resp.benefit_summaries[0].fulfillment_types #=> Array
resp.benefit_summaries[0].fulfillment_types[0] #=> String, one of "CREDITS", "CASH", "ACCESS"
resp.benefit_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 identifier to filter benefits by catalog.

  • :programs (Array<String>) —

    Filter benefits by specific AWS partner programs.

  • :fulfillment_types (Array<String>) —

    Filter benefits by specific fulfillment types.

  • :status (Array<String>) —

    Filter benefits by their current status.

  • :max_results (Integer) —

    The maximum number of benefits to return in a single response.

  • :next_token (String) —

    A pagination token to retrieve the next set of results from a previous request.

Returns:

See Also:



1222
1223
1224
1225
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1222

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

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

Retrieves all tags associated with a specific resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # 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:



1252
1253
1254
1255
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1252

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

#recall_benefit_application(params = {}) ⇒ Struct

Recalls a submitted benefit application, returning it to draft status for further modifications.

Examples:

Request syntax with placeholder values


resp = client.recall_benefit_application({
  catalog: "CatalogName", # required
  client_token: "String",
  identifier: "BenefitApplicationIdentifier", # required
  reason: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotent processing of the recall request.

  • :identifier (required, String) —

    The unique identifier of the benefit application to recall.

  • :reason (required, String) —

    A descriptive reason explaining why the benefit application is being recalled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1290
1291
1292
1293
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1290

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

#submit_benefit_application(params = {}) ⇒ Struct

Submits a benefit application for review and processing by AWS.

Examples:

Request syntax with placeholder values


resp = client.submit_benefit_application({
  catalog: "CatalogName", # required
  identifier: "BenefitApplicationIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :identifier (required, String) —

    The unique identifier of the benefit application to submit.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1317
1318
1319
1320
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1317

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # 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 add tags to.

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

    A list of key-value pairs to add as tags to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1348
1349
1350
1351
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1348

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

#untag_resource(params = {}) ⇒ Struct

Removes specified tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourceArn", # 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>) —

    A list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1374
1375
1376
1377
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1374

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

#update_benefit_application(params = {}) ⇒ Types::UpdateBenefitApplicationOutput

Updates an existing benefit application with new information while maintaining revision control.

Examples:

Request syntax with placeholder values


resp = client.update_benefit_application({
  catalog: "CatalogName", # required
  client_token: "UpdateBenefitApplicationInputClientTokenString", # required
  name: "BenefitApplicationName",
  description: "BenefitApplicationDescription",
  identifier: "BenefitApplicationIdentifier", # required
  revision: "String", # required
  benefit_application_details: {
  },
  partner_contacts: [
    {
      email: "ContactEmail",
      first_name: "ContactFirstName",
      last_name: "ContactLastName",
      business_title: "ContactBusinessTitleString",
      phone: "ContactPhone",
    },
  ],
  file_details: [
    {
      file_uri: "FileURI", # required
      business_use_case: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.revision #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • :client_token (required, String) —

    A unique, case-sensitive identifier to ensure idempotent processing of the update request.

  • :name (String) —

    The updated human-readable name for the benefit application.

  • :description (String) —

    The updated detailed description of the benefit application.

  • :identifier (required, String) —

    The unique identifier of the benefit application to update.

  • :revision (required, String) —

    The current revision number of the benefit application to ensure optimistic concurrency control.

  • :benefit_application_details (Hash, Array, String, Numeric, Boolean) —

    Updated detailed information and requirements specific to the benefit being requested.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

  • :partner_contacts (Array<Types::Contact>) —

    Updated contact information for partner representatives responsible for this benefit application.

  • :file_details (Array<Types::FileInput>) —

    Updated supporting documents and files attached to the benefit application.

Returns:

See Also:



1464
1465
1466
1467
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1464

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1493
1494
1495
 
# File 'lib/aws-sdk-partnercentralbenefits/client.rb', line 1493

def waiter_names
  []
end