You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::LicenseManager::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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

licensemanager = Aws::LicenseManager::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::LicenseManager::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::LicenseManager::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. 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.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_license_configuration(options = {}) ⇒ Types::CreateLicenseConfigurationResponse

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

Examples:

Request syntax with placeholder values


resp = client.create_license_configuration({
  name: "String", # required
  description: "String",
  license_counting_type: "vCPU", # required, accepts vCPU, Instance, Core, Socket
  license_count: 1,
  license_count_hard_limit: false,
  license_rules: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  product_information_list: [
    {
      resource_type: "String", # required
      product_information_filter_list: [ # required
        {
          product_information_filter_name: "String", # required
          product_information_filter_value: ["String"], # required
          product_information_filter_comparator: "String", # required
        },
      ],
    },
  ],
})

Response structure


resp.license_configuration_arn #=> String

Options Hash (options):

  • :name (required, String)

    Name of the license configuration.

  • :description (String)

    Description of the license configuration.

  • :license_counting_type (required, String)

    Dimension used to track the license inventory.

  • :license_count (Integer)

    Number of licenses managed by the license configuration.

  • :license_count_hard_limit (Boolean)

    Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

  • :license_rules (Array<String>)

    License rules. The syntax is #name=value (for example,

    allowedTenancy=EC2-DedicatedHost). The available rules vary by

    dimension, as follows.

    • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

    • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

    • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

    • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

    The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

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

    Tags to add to the license configuration.

  • :product_information_list (Array<Types::ProductInformation>)

    Product information.

Returns:

See Also:

#delete_license_configuration(options = {}) ⇒ Struct

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

Examples:

Request syntax with placeholder values


resp = client.delete_license_configuration({
  license_configuration_arn: "String", # required
})

Options Hash (options):

  • :license_configuration_arn (required, String)

    ID of the license configuration.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#get_license_configuration(options = {}) ⇒ Types::GetLicenseConfigurationResponse

Gets detailed information about the specified license configuration.

Examples:

Request syntax with placeholder values


resp = client.get_license_configuration({
  license_configuration_arn: "String", # required
})

Response structure


resp.license_configuration_id #=> String
resp.license_configuration_arn #=> String
resp.name #=> String
resp.description #=> String
resp.license_counting_type #=> String, one of "vCPU", "Instance", "Core", "Socket"
resp.license_rules #=> Array
resp.license_rules[0] #=> String
resp.license_count #=> Integer
resp.license_count_hard_limit #=> true/false
resp.consumed_licenses #=> Integer
resp.status #=> String
resp. #=> String
resp.consumed_license_summary_list #=> Array
resp.consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.consumed_license_summary_list[0].consumed_licenses #=> Integer
resp.managed_resource_summary_list #=> Array
resp.managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.managed_resource_summary_list[0].association_count #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.product_information_list #=> Array
resp.product_information_list[0].resource_type #=> String
resp.product_information_list[0].product_information_filter_list #=> Array
resp.product_information_list[0].product_information_filter_list[0].product_information_filter_name #=> String
resp.product_information_list[0].product_information_filter_list[0].product_information_filter_value #=> Array
resp.product_information_list[0].product_information_filter_list[0].product_information_filter_value[0] #=> String
resp.product_information_list[0].product_information_filter_list[0].product_information_filter_comparator #=> String
resp.automated_discovery_information.last_run_time #=> Time

Options Hash (options):

  • :license_configuration_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

Returns:

See Also:

#get_service_settings(options = {}) ⇒ Types::GetServiceSettingsResponse

Gets the License Manager settings for the current Region.

Examples:

Request syntax with placeholder values


resp = client.get_service_settings()

Response structure


resp.s3_bucket_arn #=> String
resp.sns_topic_arn #=> String
resp.organization_configuration.enable_integration #=> true/false
resp.enable_cross_accounts_discovery #=> true/false
resp.license_manager_resource_share_arn #=> String

Returns:

See Also:

#list_associations_for_license_configuration(options = {}) ⇒ Types::ListAssociationsForLicenseConfigurationResponse

Lists the resource associations for the specified license configuration.

Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).

Examples:

Request syntax with placeholder values


resp = client.list_associations_for_license_configuration({
  license_configuration_arn: "String", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.license_configuration_associations #=> Array
resp.license_configuration_associations[0].resource_arn #=> String
resp.license_configuration_associations[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.license_configuration_associations[0].resource_owner_id #=> String
resp.license_configuration_associations[0].association_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :license_configuration_arn (required, String)

    Amazon Resource Name (ARN) of a license configuration.

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

Returns:

See Also:

#list_failures_for_license_configuration_operations(options = {}) ⇒ Types::ListFailuresForLicenseConfigurationOperationsResponse

Lists the license configuration operations that failed.

Examples:

Request syntax with placeholder values


resp = client.list_failures_for_license_configuration_operations({
  license_configuration_arn: "String", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.license_operation_failure_list #=> Array
resp.license_operation_failure_list[0].resource_arn #=> String
resp.license_operation_failure_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.license_operation_failure_list[0].error_message #=> String
resp.license_operation_failure_list[0].failure_time #=> Time
resp.license_operation_failure_list[0].operation_name #=> String
resp.license_operation_failure_list[0].resource_owner_id #=> String
resp.license_operation_failure_list[0].operation_requested_by #=> String
resp.license_operation_failure_list[0]. #=> Array
resp.license_operation_failure_list[0].[0].name #=> String
resp.license_operation_failure_list[0].[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :license_configuration_arn (required, String)

    Amazon Resource Name of the license configuration.

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

Returns:

See Also:

#list_license_configurations(options = {}) ⇒ Types::ListLicenseConfigurationsResponse

Lists the license configurations for your account.

Examples:

Request syntax with placeholder values


resp = client.list_license_configurations({
  license_configuration_arns: ["String"],
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
})

Response structure


resp.license_configurations #=> Array
resp.license_configurations[0].license_configuration_id #=> String
resp.license_configurations[0].license_configuration_arn #=> String
resp.license_configurations[0].name #=> String
resp.license_configurations[0].description #=> String
resp.license_configurations[0].license_counting_type #=> String, one of "vCPU", "Instance", "Core", "Socket"
resp.license_configurations[0].license_rules #=> Array
resp.license_configurations[0].license_rules[0] #=> String
resp.license_configurations[0].license_count #=> Integer
resp.license_configurations[0].license_count_hard_limit #=> true/false
resp.license_configurations[0].consumed_licenses #=> Integer
resp.license_configurations[0].status #=> String
resp.license_configurations[0]. #=> String
resp.license_configurations[0].consumed_license_summary_list #=> Array
resp.license_configurations[0].consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.license_configurations[0].consumed_license_summary_list[0].consumed_licenses #=> Integer
resp.license_configurations[0].managed_resource_summary_list #=> Array
resp.license_configurations[0].managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.license_configurations[0].managed_resource_summary_list[0].association_count #=> Integer
resp.license_configurations[0].product_information_list #=> Array
resp.license_configurations[0].product_information_list[0].resource_type #=> String
resp.license_configurations[0].product_information_list[0].product_information_filter_list #=> Array
resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_name #=> String
resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_value #=> Array
resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_value[0] #=> String
resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_comparator #=> String
resp.license_configurations[0].automated_discovery_information.last_run_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :license_configuration_arns (Array<String>)

    Amazon Resource Names (ARN) of the license configurations.

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

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

    Filters to scope the results. The following filters and logical operators are supported:

    • licenseCountingType - The dimension on which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.

    • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.

    • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.

Returns:

See Also:

#list_license_specifications_for_resource(options = {}) ⇒ Types::ListLicenseSpecificationsForResourceResponse

Describes the license configurations for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_license_specifications_for_resource({
  resource_arn: "String", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.license_specifications #=> Array
resp.license_specifications[0].license_configuration_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :resource_arn (required, String)

    Amazon Resource Name (ARN) of a resource that has an associated license configuration.

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

Returns:

See Also:

#list_resource_inventory(options = {}) ⇒ Types::ListResourceInventoryResponse

Lists resources managed using Systems Manager inventory.

Examples:

Request syntax with placeholder values


resp = client.list_resource_inventory({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name: "String", # required
      condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, BEGINS_WITH, CONTAINS
      value: "String",
    },
  ],
})

Response structure


resp.resource_inventory_list #=> Array
resp.resource_inventory_list[0].resource_id #=> String
resp.resource_inventory_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.resource_inventory_list[0].resource_arn #=> String
resp.resource_inventory_list[0].platform #=> String
resp.resource_inventory_list[0].platform_version #=> String
resp.resource_inventory_list[0]. #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

  • :filters (Array<Types::InventoryFilter>)

    Filters to scope the results. The following filters and logical operators are supported:

    • account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

    • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.

    • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

    • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.

    • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

Returns:

See Also:

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

Lists the tags for the specified license configuration.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

Returns:

See Also:

#list_usage_for_license_configuration(options = {}) ⇒ Types::ListUsageForLicenseConfigurationResponse

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

Examples:

Request syntax with placeholder values


resp = client.list_usage_for_license_configuration({
  license_configuration_arn: "String", # required
  max_results: 1,
  next_token: "String",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
})

Response structure


resp.license_configuration_usage_list #=> Array
resp.license_configuration_usage_list[0].resource_arn #=> String
resp.license_configuration_usage_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
resp.license_configuration_usage_list[0].resource_status #=> String
resp.license_configuration_usage_list[0].resource_owner_id #=> String
resp.license_configuration_usage_list[0].association_time #=> Time
resp.license_configuration_usage_list[0].consumed_licenses #=> Integer
resp.next_token #=> String

Options Hash (options):

  • :license_configuration_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

  • :max_results (Integer)

    Maximum number of results to return in a single call.

  • :next_token (String)

    Token for the next set of results.

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

    Filters to scope the results. The following filters and logical operators are supported:

    • resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.

    • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.

    • resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds the specified tags to the specified license configuration.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

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

    One or more tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes the specified tags from the specified license configuration.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

  • :tag_keys (required, Array<String>)

    Keys identifying the tags to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_license_configuration(options = {}) ⇒ Struct

Modifies the attributes of an existing license configuration.

Examples:

Request syntax with placeholder values


resp = client.update_license_configuration({
  license_configuration_arn: "String", # required
  license_configuration_status: "AVAILABLE", # accepts AVAILABLE, DISABLED
  license_rules: ["String"],
  license_count: 1,
  license_count_hard_limit: false,
  name: "String",
  description: "String",
  product_information_list: [
    {
      resource_type: "String", # required
      product_information_filter_list: [ # required
        {
          product_information_filter_name: "String", # required
          product_information_filter_value: ["String"], # required
          product_information_filter_comparator: "String", # required
        },
      ],
    },
  ],
})

Options Hash (options):

  • :license_configuration_arn (required, String)

    Amazon Resource Name (ARN) of the license configuration.

  • :license_configuration_status (String)

    New status of the license configuration.

  • :license_rules (Array<String>)

    New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

  • :license_count (Integer)

    New number of licenses managed by the license configuration.

  • :license_count_hard_limit (Boolean)

    New hard limit of the number of available licenses.

  • :name (String)

    New name of the license configuration.

  • :description (String)

    New description of the license configuration.

  • :product_information_list (Array<Types::ProductInformation>)

    New product information.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_license_specifications_for_resource(options = {}) ⇒ Struct

Adds or removes the specified license configurations for the specified AWS resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.

Examples:

Request syntax with placeholder values


resp = client.update_license_specifications_for_resource({
  resource_arn: "String", # required
  add_license_specifications: [
    {
      license_configuration_arn: "String", # required
    },
  ],
  remove_license_specifications: [
    {
      license_configuration_arn: "String", # required
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String)

    Amazon Resource Name (ARN) of the AWS resource.

  • :add_license_specifications (Array<Types::LicenseSpecification>)

    ARNs of the license configurations to add.

  • :remove_license_specifications (Array<Types::LicenseSpecification>)

    ARNs of the license configurations to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_service_settings(options = {}) ⇒ Struct

Updates License Manager settings for the current Region.

Examples:

Request syntax with placeholder values


resp = client.update_service_settings({
  s3_bucket_arn: "String",
  sns_topic_arn: "String",
  organization_configuration: {
    enable_integration: false, # required
  },
  enable_cross_accounts_discovery: false,
})

Options Hash (options):

  • :s3_bucket_arn (String)

    Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

  • :sns_topic_arn (String)

    Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

  • :organization_configuration (Types::OrganizationConfiguration)

    Enables integration with AWS Organizations for cross-account discovery.

  • :enable_cross_accounts_discovery (Boolean)

    Activates cross-account discovery.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.