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

Class: Aws::LicenseManager::Client

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

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

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search 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)
  • :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.

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

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

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

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :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 yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

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



261
262
263
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

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

Creates a new license configuration object. 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), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), 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",
    },
  ],
})

Response structure


resp.license_configuration_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    Name of the license configuration.

  • :description (String)

    Human-friendly description of the license configuration.

  • :license_counting_type (required, String)

    Dimension to use to track the license inventory.

  • :license_count (Integer)

    Number of licenses managed by the license configuration.

  • :license_count_hard_limit (Boolean)

    Flag indicating whether hard or soft license enforcement is used. Exceeding a hard limit results in the blocked deployment of new instances.

  • :license_rules (Array<String>)

    Array of configured License Manager rules.

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

    The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .

Returns:

See Also:



330
331
332
333
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 330

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

#delete_license_configuration(params = {}) ⇒ Struct

Deletes an existing license configuration. This action fails if the configuration is in use.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arn (required, String)

    Unique ID of the configuration object to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



353
354
355
356
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 353

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

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

Returns a detailed description of a 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 #=> Boolean
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"
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"
resp.managed_resource_summary_list[0].association_count #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arn (required, String)

    ARN of the license configuration being requested.

Returns:

See Also:



414
415
416
417
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 414

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

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

Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection.

Examples:

Response structure


resp.s3_bucket_arn #=> String
resp.sns_topic_arn #=> String
resp.organization_configuration.enable_integration #=> Boolean
resp.enable_cross_accounts_discovery #=> Boolean

Parameters:

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

    ({})

Returns:

See Also:



440
441
442
443
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 440

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

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

Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration.

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"
resp.license_configuration_associations[0].resource_owner_id #=> String
resp.license_configuration_associations[0].association_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arn (required, String)

    ARN of a LicenseConfiguration object.

  • :max_results (Integer)

    Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String)

    Token for the next set of results.

Returns:

See Also:



488
489
490
491
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 488

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

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

Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.

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 #=> Boolean
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"
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"
resp.license_configurations[0].managed_resource_summary_list[0].association_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arns (Array<String>)

    An array of ARNs for the calling account’s license configurations.

  • :max_results (Integer)

    Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String)

    Token for the next set of results.

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

    One or more filters.

Returns:

See Also:



557
558
559
560
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 557

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

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

Returns the license configuration for a 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    ARN of an AMI or Amazon EC2 instance that has an associated license configuration.

  • :max_results (Integer)

    Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String)

    Token for the next set of results.

Returns:

See Also:



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

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

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

Returns a detailed list of resources.

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"
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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

    Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String)

    Token for the next set of results.

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

    One or more filters.

Returns:

See Also:



651
652
653
654
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 651

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

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

Lists tags attached to a resource.

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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    ARN for the resource.

Returns:

See Also:



681
682
683
684
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 681

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

#list_usage_for_license_configuration(params = {}) ⇒ 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"
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

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arn (required, String)

    ARN of the targeted LicenseConfiguration object.

  • :max_results (Integer)

    Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String)

    Token for the next set of results.

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

    List of filters to apply.

Returns:

See Also:



739
740
741
742
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 739

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

#tag_resource(params = {}) ⇒ Struct

Attach one of more tags to any resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    Resource of the ARN to be tagged.

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

    Names of the tags to attach to the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



770
771
772
773
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 770

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

#untag_resource(params = {}) ⇒ Struct

Remove tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    ARN of the resource.

  • :tag_keys (required, Array<String>)

    List keys identifying tags to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



796
797
798
799
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 796

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

#update_license_configuration(params = {}) ⇒ Struct

Modifies the attributes of an existing license configuration object. 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 (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used.

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",
})

Parameters:

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

    ({})

Options Hash (params):

  • :license_configuration_arn (required, String)

    ARN for a license configuration.

  • :license_configuration_status (String)

    New status of the license configuration (ACTIVE or INACTIVE).

  • :license_rules (Array<String>)

    List of flexible text strings designating license rules.

  • :license_count (Integer)

    New number of licenses managed by the license configuration.

  • :license_count_hard_limit (Boolean)

    Sets the number of available licenses as a hard limit.

  • :name (String)

    New name of the license configuration.

  • :description (String)

    New human-friendly description of the license configuration.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



848
849
850
851
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 848

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

#update_license_specifications_for_resource(params = {}) ⇒ Struct

Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances.

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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    ARN for an AWS server resource.

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

    License configuration ARNs to be added to a resource.

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

    License configuration ARNs to be removed from a resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



891
892
893
894
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 891

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

#update_service_settings(params = {}) ⇒ Struct

Updates License Manager service settings.

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,
})

Parameters:

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

    ({})

Options Hash (params):

  • :s3_bucket_arn (String)

    ARN of the Amazon S3 bucket where License Manager information is stored.

  • :sns_topic_arn (String)

    ARN of the Amazon SNS topic used for License Manager alerts.

  • :organization_configuration (Types::OrganizationConfiguration)

    Integrates AWS Organizations with License Manager for cross-account discovery.

  • :enable_cross_accounts_discovery (Boolean)

    Activates cross-account discovery.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



929
930
931
932
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 929

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