Class: Aws::PricingPlanManager::Client

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

Overview

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

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

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

def initialize(*args)
  super
end

Instance Method Details

#approve_paid_subscription(params = {}) ⇒ Types::ApprovePaidSubscriptionOutput

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response.

Examples:

Example: Approve a pending paid subscription


resp = client.approve_paid_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "1", 
})

resp.to_h outputs the following:
{
  e_tag: "2", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "SYNC_IN_PROGRESS", 
    updated_at: Time.parse("2025-01-15T10:35:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.approve_paid_subscription({
  arn: "SubscriptionArn", # required
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to approve.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are approving the expected version of the subscription.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



561
562
563
564
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 561

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

#associate_resources_to_subscription(params = {}) ⇒ Types::AssociateResourcesToSubscriptionOutput

Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.

Examples:

Example: Associate additional resources to a subscription


resp = client.associate_resources_to_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "1", 
  resource_arns: [
    "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE", 
  ], 
})

resp.to_h outputs the following:
{
  e_tag: "2", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
      "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE", 
    ], 
    status: "SYNC_IN_PROGRESS", 
    updated_at: Time.parse("2025-01-18T11:00:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.associate_resources_to_subscription({
  arn: "SubscriptionArn", # required
  resource_arns: ["String"], # required
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to add resources to.

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

    The ARNs of the resources to add to the subscription.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



659
660
661
662
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 659

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

#cancel_subscription(params = {}) ⇒ Types::CancelSubscriptionOutput

Cancels a flat-rate pricing subscription.

For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange.

For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling.

Examples:

Example: Cancel a subscription


resp = client.cancel_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "2", 
})

resp.to_h outputs the following:
{
  e_tag: "3", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "BUSINESS", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    scheduled_change: {
      change_type: "CANCELLATION", 
      effective_date: Time.parse("2025-02-01T00:00:00Z"), 
    }, 
    status: "ACTIVE", 
    updated_at: Time.parse("2025-01-16T12:00:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.cancel_subscription({
  arn: "SubscriptionArn", # required
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to cancel.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



754
755
756
757
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 754

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

#cancel_subscription_change(params = {}) ⇒ Types::CancelSubscriptionChangeOutput

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.

Examples:

Example: Cancel a pending subscription change


resp = client.cancel_subscription_change({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "3", 
})

resp.to_h outputs the following:
{
  e_tag: "4", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "BUSINESS", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "ACTIVE", 
    updated_at: Time.parse("2025-01-17T09:00:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.cancel_subscription_change({
  arn: "SubscriptionArn", # required
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription whose pending change you want to cancel.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



843
844
845
846
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 843

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

#create_subscription(params = {}) ⇒ Types::CreateSubscriptionOutput

Creates a flat-rate pricing subscription for the specified resources.

When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.

Examples:

Example: Create a flat-rate pricing subscription (deferred approval)


resp = client.create_subscription({
  approval_mode: "MANUAL", 
  plan_family: "CloudFront", 
  plan_tier: "PRO", 
  resource_arns: [
    "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
    "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
  ], 
})

resp.to_h outputs the following:
{
  e_tag: "1", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "PENDING_APPROVAL", 
    updated_at: Time.parse("2025-01-15T10:30:00Z"), 
  }, 
}

Example: Create a subscription with approval mode


resp = client.create_subscription({
  approval_mode: "IMMEDIATE", 
  plan_family: "CloudFront", 
  plan_tier: "PRO", 
  resource_arns: [
    "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
    "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
  ], 
})

resp.to_h outputs the following:
{
  e_tag: "1", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "SYNC_IN_PROGRESS", 
    updated_at: Time.parse("2025-01-15T10:30:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.create_subscription({
  plan_family: "String", # required
  plan_tier: "String", # required
  usage_level: "String",
  resource_arns: ["String"], # required
  approval_mode: "MANUAL", # accepts MANUAL, IMMEDIATE
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :plan_family (required, String) —

    The pricing plan family to subscribe to, such as CloudFront.

  • :plan_tier (required, String) —

    The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.

  • :usage_level (String) —

    The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.

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

    The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.

    For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

  • :approval_mode (String) —

    Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.

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

Returns:

See Also:



995
996
997
998
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 995

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

#disassociate_resources_from_subscription(params = {}) ⇒ Types::DisassociateResourcesFromSubscriptionOutput

Removes one or more resources from an existing subscription.

For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.

Examples:

Example: Remove a resource from a subscription


resp = client.disassociate_resources_from_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "2", 
  resource_arns: [
    "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE", 
  ], 
})

resp.to_h outputs the following:
{
  e_tag: "3", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "SYNC_IN_PROGRESS", 
    updated_at: Time.parse("2025-01-18T15:00:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.disassociate_resources_from_subscription({
  arn: "SubscriptionArn", # required
  resource_arns: ["String"], # required
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to remove resources from.

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

    The ARNs of the resources to remove from the subscription. For subscriptions in the CloudFront plan family, you cannot remove the required CloudFront distribution or WAF web ACL.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



1092
1093
1094
1095
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 1092

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

#get_subscription(params = {}) ⇒ Types::GetSubscriptionOutput

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

Examples:

Example: Get subscription details


resp = client.get_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
})

resp.to_h outputs the following:
{
  e_tag: "1", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "PRO", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "ACTIVE", 
    updated_at: Time.parse("2025-01-15T10:30:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.get_subscription({
  arn: "SubscriptionArn", # required
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to retrieve.

Returns:

See Also:



1161
1162
1163
1164
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 1161

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

#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsOutput

Returns a summary of all flat-rate pricing subscriptions in the calling account.

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

Examples:

Example: List all subscriptions


resp = client.list_subscriptions({
})

resp.to_h outputs the following:
{
  subscription_summaries: [
    {
      arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
      created_at: Time.parse("2025-01-15T10:30:00Z"), 
      e_tag: "1", 
      plan_family: "CloudFront", 
      plan_tier: "PRO", 
      resource_arns: [
        "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
        "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
      ], 
      status: "ACTIVE", 
      updated_at: Time.parse("2025-01-15T10:30:00Z"), 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_subscriptions({
  next_token: "String",
})

Response structure


resp.subscription_summaries #=> Array
resp.subscription_summaries[0].arn #=> String
resp.subscription_summaries[0].plan_family #=> String
resp.subscription_summaries[0].plan_tier #=> String
resp.subscription_summaries[0].usage_level #=> String
resp.subscription_summaries[0].scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription_summaries[0].scheduled_change.effective_date #=> Time
resp.subscription_summaries[0].scheduled_change.plan_tier #=> String
resp.subscription_summaries[0].scheduled_change.usage_level #=> String
resp.subscription_summaries[0].status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription_summaries[0].status_reason #=> String
resp.subscription_summaries[0].resource_arns #=> Array
resp.subscription_summaries[0].resource_arns[0] #=> String
resp.subscription_summaries[0].created_at #=> Time
resp.subscription_summaries[0].updated_at #=> Time
resp.subscription_summaries[0].e_tag #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    A token from a previous ListSubscriptions response. If the response included a nextToken, there are more results available. Pass this value to retrieve the next page of results.

Returns:

See Also:



1236
1237
1238
1239
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 1236

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

#update_subscription(params = {}) ⇒ Types::UpdateSubscriptionOutput

Changes the plan tier of an existing subscription.

Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange.

This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default.

Examples:

Example: Update a subscription plan tier


resp = client.update_subscription({
  arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
  if_match: "1", 
  plan_tier: "BUSINESS", 
})

resp.to_h outputs the following:
{
  e_tag: "2", 
  subscription: {
    arn: "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", 
    created_at: Time.parse("2025-01-15T10:30:00Z"), 
    plan_family: "CloudFront", 
    plan_tier: "BUSINESS", 
    resource_arns: [
      "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", 
      "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", 
    ], 
    status: "SYNC_IN_PROGRESS", 
    updated_at: Time.parse("2025-01-16T08:00:00Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.update_subscription({
  arn: "SubscriptionArn", # required
  plan_tier: "String", # required
  usage_level: "String",
  if_match: "String", # required
  client_token: "IdempotencyToken",
})

Response structure


resp.subscription.arn #=> String
resp.subscription.plan_family #=> String
resp.subscription.plan_tier #=> String
resp.subscription.usage_level #=> String
resp.subscription.scheduled_change.change_type #=> String, one of "DOWNGRADE", "CANCELLATION"
resp.subscription.scheduled_change.effective_date #=> Time
resp.subscription.scheduled_change.plan_tier #=> String
resp.subscription.scheduled_change.usage_level #=> String
resp.subscription.status #=> String, one of "PENDING_APPROVAL", "ACTIVE", "SYNC_IN_PROGRESS", "FAILED"
resp.subscription.status_reason #=> String
resp.subscription.resource_arns #=> Array
resp.subscription.resource_arns[0] #=> String
resp.subscription.created_at #=> Time
resp.subscription.updated_at #=> Time
resp.e_tag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the subscription to update.

  • :plan_tier (required, String) —

    The new tier level for the subscription.

  • :usage_level (String) —

    The usage level within the plan tier. Specify DEFAULT for the base configuration. If omitted, the usage level is reset to the default.

  • :if_match (required, String) —

    The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are updating the expected version of the subscription.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

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

Returns:

See Also:



1339
1340
1341
1342
 
# File 'gems/aws-sdk-pricingplanmanager/lib/aws-sdk-pricingplanmanager/client.rb', line 1339

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