Class: Aws::LicenseManagerLinuxSubscriptions::Client

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

Overview

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

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

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

def initialize(*args)
  super
end

Instance Method Details

#deregister_subscription_provider(params = {}) ⇒ Struct

Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.

Examples:

Request syntax with placeholder values


resp = client.deregister_subscription_provider({
  subscription_provider_arn: "SubscriptionProviderArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :subscription_provider_arn (required, String) —

    The Amazon Resource Name (ARN) of the subscription provider resource to deregister.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



496
497
498
499
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 496

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

#get_registered_subscription_provider(params = {}) ⇒ Types::GetRegisteredSubscriptionProviderResponse

Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.

Examples:

Request syntax with placeholder values


resp = client.get_registered_subscription_provider({
  subscription_provider_arn: "SubscriptionProviderArn", # required
})

Response structure


resp.last_successful_data_retrieval_time #=> String
resp.secret_arn #=> String
resp.subscription_provider_arn #=> String
resp.subscription_provider_source #=> String, one of "RedHat"
resp.subscription_provider_status #=> String, one of "ACTIVE", "INVALID", "PENDING"
resp.subscription_provider_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :subscription_provider_arn (required, String) —

    The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.

Returns:

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 536

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

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

Lists the Linux subscriptions service settings for your account.

Examples:

Response structure


resp.home_regions #=> Array
resp.home_regions[0] #=> String
resp.linux_subscriptions_discovery #=> String, one of "Enabled", "Disabled"
resp.linux_subscriptions_discovery_settings.organization_integration #=> String, one of "Enabled", "Disabled"
resp.linux_subscriptions_discovery_settings.source_regions #=> Array
resp.linux_subscriptions_discovery_settings.source_regions[0] #=> String
resp.status #=> String, one of "InProgress", "Completed", "Successful", "Failed"
resp.status_message #=> Hash
resp.status_message["String"] #=> String

Parameters:

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

    ({})

Returns:

See Also:



567
568
569
570
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 567

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

#list_linux_subscription_instances(params = {}) ⇒ Types::ListLinuxSubscriptionInstancesResponse

Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.

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

Examples:

Request syntax with placeholder values


resp = client.list_linux_subscription_instances({
  filters: [
    {
      name: "String",
      operator: "Equal", # accepts Equal, NotEqual, Contains
      values: ["StringListMemberString"],
    },
  ],
  max_results: 1,
  next_token: "ListLinuxSubscriptionInstancesRequestNextTokenString",
})

Response structure


resp.instances #=> Array
resp.instances[0]. #=> String
resp.instances[0].ami_id #=> String
resp.instances[0].dual_subscription #=> String
resp.instances[0].instance_id #=> String
resp.instances[0].instance_type #=> String
resp.instances[0].last_updated_time #=> String
resp.instances[0].os_version #=> String
resp.instances[0].product_code #=> Array
resp.instances[0].product_code[0] #=> String
resp.instances[0].region #=> String
resp.instances[0].registered_with_subscription_provider #=> String
resp.instances[0].status #=> String
resp.instances[0].subscription_name #=> String
resp.instances[0].subscription_provider_create_time #=> String
resp.instances[0].subscription_provider_update_time #=> String
resp.instances[0].usage_operation #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    An array of structures that you can use to filter the results by your specified criteria. For example, you can specify Region in the Name, with the contains operator to list all subscriptions that match a partial string in the Value, such as us-west.

    For each filter, you can specify one of the following values for the Name key to streamline results:

    • AccountID

    • AmiID

    • DualSubscription

    • InstanceID

    • InstanceType

    • ProductCode

    • Region

    • Status

    • UsageOperation

    For each filter, you can use one of the following Operator values to define the behavior of the filter:

    • contains

    • equals

    • Notequal

  • :max_results (Integer) —

    The maximum items to return in a request.

  • :next_token (String) —

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Returns:

See Also:



664
665
666
667
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 664

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

#list_linux_subscriptions(params = {}) ⇒ Types::ListLinuxSubscriptionsResponse

Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.

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

Examples:

Request syntax with placeholder values


resp = client.list_linux_subscriptions({
  filters: [
    {
      name: "String",
      operator: "Equal", # accepts Equal, NotEqual, Contains
      values: ["StringListMemberString"],
    },
  ],
  max_results: 1,
  next_token: "ListLinuxSubscriptionsRequestNextTokenString",
})

Response structure


resp.next_token #=> String
resp.subscriptions #=> Array
resp.subscriptions[0].instance_count #=> Integer
resp.subscriptions[0].name #=> String
resp.subscriptions[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of Subscription with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name.

    The valid names for this filter are:

    • Subscription

    ^

    The valid Operators for this filter are:

    • contains

    • equals

    • Notequal

  • :max_results (Integer) —

    The maximum items to return in a request.

  • :next_token (String) —

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Returns:

See Also:



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

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

#list_registered_subscription_providers(params = {}) ⇒ Types::ListRegisteredSubscriptionProvidersResponse

List Bring Your Own License (BYOL) subscription registration resources for your account.

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

Examples:

Request syntax with placeholder values


resp = client.list_registered_subscription_providers({
  max_results: 1,
  next_token: "String",
  subscription_provider_sources: ["RedHat"], # accepts RedHat
})

Response structure


resp.next_token #=> String
resp.registered_subscription_providers #=> Array
resp.registered_subscription_providers[0].last_successful_data_retrieval_time #=> String
resp.registered_subscription_providers[0].secret_arn #=> String
resp.registered_subscription_providers[0].subscription_provider_arn #=> String
resp.registered_subscription_providers[0].subscription_provider_source #=> String, one of "RedHat"
resp.registered_subscription_providers[0].subscription_provider_status #=> String, one of "ACTIVE", "INVALID", "PENDING"
resp.registered_subscription_providers[0].subscription_provider_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum items to return in a request.

  • :next_token (String) —

    A token to specify where to start paginating. This is the nextToken from a previously truncated response.

  • :subscription_provider_sources (Array<String>) —

    To filter your results, specify which subscription providers to return in the list.

Returns:

See Also:



783
784
785
786
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 783

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

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

List the metadata tags that are assigned to the specified Amazon Web Services resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



814
815
816
817
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 814

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

#register_subscription_provider(params = {}) ⇒ Types::RegisterSubscriptionProviderResponse

Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.

Examples:

Request syntax with placeholder values


resp = client.register_subscription_provider({
  secret_arn: "SecretArn", # required
  subscription_provider_source: "RedHat", # required, accepts RedHat
  tags: {
    "String" => "String",
  },
})

Response structure


resp.subscription_provider_arn #=> String
resp.subscription_provider_source #=> String, one of "RedHat"
resp.subscription_provider_status #=> String, one of "ACTIVE", "INVALID", "PENDING"

Parameters:

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

    ({})

Options Hash (params):

  • :secret_arn (required, String) —

    The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token.

  • :subscription_provider_source (required, String) —

    The supported Linux subscription provider to register.

  • :tags (Hash<String,String>) —

    The metadata tags to assign to your registered Linux subscription provider resource.

Returns:

See Also:



861
862
863
864
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 861

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

#tag_resource(params = {}) ⇒ Struct

Add metadata tags to the specified Amazon Web Services resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "SubscriptionProviderArn", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags.

  • :tags (required, Hash<String,String>) —

    The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#untag_resource(params = {}) ⇒ Struct

Remove one or more metadata tag from the specified Amazon Web Services resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

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

    A list of metadata tag keys to remove from the requested resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



919
920
921
922
 
# File 'gems/aws-sdk-licensemanagerlinuxsubscriptions/lib/aws-sdk-licensemanagerlinuxsubscriptions/client.rb', line 919

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

#update_service_settings(params = {}) ⇒ Types::UpdateServiceSettingsResponse

Updates the service settings for Linux subscriptions.

Examples:

Request syntax with placeholder values


resp = client.update_service_settings({
  allow_update: false,
  linux_subscriptions_discovery: "Enabled", # required, accepts Enabled, Disabled
  linux_subscriptions_discovery_settings: { # required
    organization_integration: "Enabled", # required, accepts Enabled, Disabled
    source_regions: ["StringListMemberString"], # required
  },
})

Response structure


resp.home_regions #=> Array
resp.home_regions[0] #=> String
resp.linux_subscriptions_discovery #=> String, one of "Enabled", "Disabled"
resp.linux_subscriptions_discovery_settings.organization_integration #=> String, one of "Enabled", "Disabled"
resp.linux_subscriptions_discovery_settings.source_regions #=> Array
resp.linux_subscriptions_discovery_settings.source_regions[0] #=> String
resp.status #=> String, one of "InProgress", "Completed", "Successful", "Failed"
resp.status_message #=> Hash
resp.status_message["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :allow_update (Boolean) —

    Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.

  • :linux_subscriptions_discovery (required, String) —

    Describes if the discovery of Linux subscriptions is enabled.

  • :linux_subscriptions_discovery_settings (required, Types::LinuxSubscriptionsDiscoverySettings) —

    The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

Returns:

See Also:



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

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