Class: Aws::LicenseManager::Client

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

Overview

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

client = Aws::LicenseManager::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.

Defined Under Namespace

Modules: _AcceptGrantResponseSuccess, _CheckInLicenseResponseSuccess, _CheckoutBorrowLicenseResponseSuccess, _CheckoutLicenseResponseSuccess, _CreateGrantResponseSuccess, _CreateGrantVersionResponseSuccess, _CreateLicenseAssetGroupResponseSuccess, _CreateLicenseAssetRulesetResponseSuccess, _CreateLicenseConfigurationResponseSuccess, _CreateLicenseConversionTaskForResourceResponseSuccess, _CreateLicenseManagerReportGeneratorResponseSuccess, _CreateLicenseResponseSuccess, _CreateLicenseVersionResponseSuccess, _CreateTokenResponseSuccess, _DeleteGrantResponseSuccess, _DeleteLicenseAssetGroupResponseSuccess, _DeleteLicenseAssetRulesetResponseSuccess, _DeleteLicenseConfigurationResponseSuccess, _DeleteLicenseManagerReportGeneratorResponseSuccess, _DeleteLicenseResponseSuccess, _DeleteTokenResponseSuccess, _ExtendLicenseConsumptionResponseSuccess, _GetAccessTokenResponseSuccess, _GetGrantResponseSuccess, _GetLicenseAssetGroupResponseSuccess, _GetLicenseAssetRulesetResponseSuccess, _GetLicenseConfigurationResponseSuccess, _GetLicenseConversionTaskResponseSuccess, _GetLicenseManagerReportGeneratorResponseSuccess, _GetLicenseResponseSuccess, _GetLicenseUsageResponseSuccess, _GetServiceSettingsResponseSuccess, _ListAssetsForLicenseAssetGroupResponseSuccess, _ListAssociationsForLicenseConfigurationResponseSuccess, _ListDistributedGrantsResponseSuccess, _ListFailuresForLicenseConfigurationOperationsResponseSuccess, _ListLicenseAssetGroupsResponseSuccess, _ListLicenseAssetRulesetsResponseSuccess, _ListLicenseConfigurationsForOrganizationResponseSuccess, _ListLicenseConfigurationsResponseSuccess, _ListLicenseConversionTasksResponseSuccess, _ListLicenseManagerReportGeneratorsResponseSuccess, _ListLicenseSpecificationsForResourceResponseSuccess, _ListLicenseVersionsResponseSuccess, _ListLicensesResponseSuccess, _ListReceivedGrantsForOrganizationResponseSuccess, _ListReceivedGrantsResponseSuccess, _ListReceivedLicensesForOrganizationResponseSuccess, _ListReceivedLicensesResponseSuccess, _ListResourceInventoryResponseSuccess, _ListTagsForResourceResponseSuccess, _ListTokensResponseSuccess, _ListUsageForLicenseConfigurationResponseSuccess, _RejectGrantResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateLicenseAssetGroupResponseSuccess, _UpdateLicenseAssetRulesetResponseSuccess, _UpdateLicenseConfigurationResponseSuccess, _UpdateLicenseManagerReportGeneratorResponseSuccess, _UpdateLicenseSpecificationsForResourceResponseSuccess, _UpdateServiceSettingsResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:entitlement) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  




  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or instance of any one of the following classes:
    

      

    • 

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

      • 

    • 

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

      • 

    • 

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

      • 

    • 

      Aws::AssumeRoleWebIdentityCredentials - Used when you need to
assume a role after providing credentials via the web.
      

      • 

    • 

      Aws::SSOCredentials - Used for loading credentials from AWS SSO using an
access token generated from aws login.
      

      • 

    • 

      Aws::ProcessCredentials - Used for loading credentials from a
process that outputs to stdout.
      

      • 

    • 

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

      • 

    • 

      Aws::ECSCredentials - Used for loading credentials from
instances running in ECS.
      

      • 

    • 

      Aws::CognitoIdentityCredentials - Used for loading credentials
from the Cognito Identity service.
      

      • 

    

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

      

    • 

      Aws.config[: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
      • 

    
          
        
    • 
      
        
  • 
          :simple_json
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Disables request parameter conversion, validation, and formatting.
Also disables response data type conversions. The request parameters
hash must be formatted exactly as the API expects.This option is useful
when you want to ensure the highest level of performance by avoiding
overhead of walking request parameters and response data structures.
    
          
        
    • 
      
        
  • 
          :stub_responses
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.
    

    ** Please note ** When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk gem and then, pass in an instance of a
Aws::Telemetry::OTelProvider for telemetry provider.
      • 

    
          
        
    • 
      
        
  • 
          :token_provider
          (Aws::TokenProvider)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or instance of any one of the following classes:
    

      

    • 

      Aws::StaticTokenProvider - Used for configuring static, non-refreshing
tokens.
      

      • 

    • 

      Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an
access token generated from aws login.
      

      • 

    

    When :token_provider is not configured directly, the Aws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files.
    
          
        
    • 
      
        
  • 
          :use_dualstack_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, dualstack enabled endpoints (with .aws TLD)
will be used if available.
    
          
        
    • 
      
        
  • 
          :use_fips_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, fips compatible endpoints will be used if available.
When a fips region is used, the region is normalized and this config
is set to true.
    
          
        
    • 
      
        
  • 
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, request parameters are validated before
sending the request.
    
          
        
    • 
      
        
  • 
          :endpoint_provider
          (Aws::LicenseManager::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::LicenseManager::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.
    
          
        
    • 
      
    

  








  

    
      


478
479
480

    		
    
      
# File 'lib/aws-sdk-licensemanager/client.rb', line 478

def initialize(*args)
  super
end


    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  




  

    

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




  





  



  

    
      


4402
4403
4404

    		
    
      
# File 'lib/aws-sdk-licensemanager/client.rb', line 4402

def identifier
  @identifier
end


    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  




  

    

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




  





  



  

    
      


4405
4406
4407

    		
    
      
# File 'lib/aws-sdk-licensemanager/client.rb', line 4405

def errors_module
  Errors
end


    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/LicenseManager/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (


    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #accept_grant(params = {})  ⇒ Types::AcceptGrantResponse 
  

  

  




  

    
Accepts the specified grant.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.accept_grant({
  grant_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.grant_arn #=> String
resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the grant.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


89

    		
    
      
# File 'sig/client.rbs', line 89

def accept_grant: (


    		
  





    
      

  

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

  

  




  

    

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




  





  
Parameters:


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






  

    
      


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391

    		
    
      
# File 'lib/aws-sdk-licensemanager/client.rb', line 4375

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


    		
  





    
      

  

  
    #check_in_license(params = {})  ⇒ Struct 
  

  

  




  

    
Checks in the specified license. Check in a license when it is no
longer in use.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.check_in_license({
  license_consumption_token: "String", # required
  beneficiary: "String",
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_consumption_token
          (required, String)
          
            
          
          
            — 
    License consumption token.
    
          
        
    • 
      
        
  • 
          :beneficiary
          (String)
          
            
          
          
            — 
    License beneficiary.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


98

    		
    
      
# File 'sig/client.rbs', line 98

def check_in_license: (


    		
  





    
      

  

  
    #checkout_borrow_license(params = {})  ⇒ Types::CheckoutBorrowLicenseResponse 
  

  

  




  

    
Checks out the specified license for offline use.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.checkout_borrow_license({
  license_arn: "Arn", # required
  entitlements: [ # required
    {
      name: "String", # required
      value: "String",
      unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
    },
  ],
  digital_signature_method: "JWT_PS384", # required, accepts JWT_PS384
  node_id: "String",
  checkout_metadata: [
    {
      name: "String",
      value: "String",
    },
  ],
  client_token: "ClientToken", # required
})


    
      
        
Response structure

      
      

resp.license_arn #=> String
resp.license_consumption_token #=> String
resp.entitlements_allowed #=> Array
resp.entitlements_allowed[0].name #=> String
resp.entitlements_allowed[0].value #=> String
resp.entitlements_allowed[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.node_id #=> String
resp.signed_token #=> String
resp.issued_at #=> String
resp.expiration #=> String
resp.checkout_metadata #=> Array
resp.checkout_metadata[0].name #=> String
resp.checkout_metadata[0].value #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license. The license must use the
borrow consumption configuration.
    
          
        
    • 
      
        
  • 
          :entitlements
          (required, Array<Types::EntitlementData>)
          
            
          
          
            — 
    License entitlements. Partial checkouts are not supported.
    
          
        
    • 
      
        
  • 
          :digital_signature_method
          (required, String)
          
            
          
          
            — 
    Digital signature method. The possible value is JSON Web Signature
(JWS) algorithm PS384. For more information, see RFC 7518 Digital
Signature with RSASSA-PSS.
    
          
        
    • 
      
        
  • 
          :node_id
          (String)
          
            
          
          
            — 
    Node ID.
    
          
        
    • 
      
        
  • 
          :checkout_metadata
          (Array<Types::Metadata>)
          
            
          
          
            — 
    Information about constraints.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


116

    		
    
      
# File 'sig/client.rbs', line 116

def checkout_borrow_license: (


    		
  





    
      

  

  
    #checkout_license(params = {})  ⇒ Types::CheckoutLicenseResponse 
  

  

  




  

    
Checks out the specified license.


 If the account that created the license is the same that is performing
the check out, you must specify the account as the beneficiary.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.checkout_license({
  product_sku: "String", # required
  checkout_type: "PROVISIONAL", # required, accepts PROVISIONAL, PERPETUAL
  key_fingerprint: "String", # required
  entitlements: [ # required
    {
      name: "String", # required
      value: "String",
      unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
    },
  ],
  client_token: "ClientToken", # required
  beneficiary: "String",
  node_id: "String",
})


    
      
        
Response structure

      
      

resp.checkout_type #=> String, one of "PROVISIONAL", "PERPETUAL"
resp.license_consumption_token #=> String
resp.entitlements_allowed #=> Array
resp.entitlements_allowed[0].name #=> String
resp.entitlements_allowed[0].value #=> String
resp.entitlements_allowed[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.signed_token #=> String
resp.node_id #=> String
resp.issued_at #=> String
resp.expiration #=> String
resp.license_arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :product_sku
          (required, String)
          
            
          
          
            — 
    Product SKU.
    
          
        
    • 
      
        
  • 
          :checkout_type
          (required, String)
          
            
          
          
            — 
    Checkout type.
    
          
        
    • 
      
        
  • 
          :key_fingerprint
          (required, String)
          
            
          
          
            — 
    Key fingerprint identifying the license.
    
          
        
    • 
      
        
  • 
          :entitlements
          (required, Array<Types::EntitlementData>)
          
            
          
          
            — 
    License entitlements.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :beneficiary
          (String)
          
            
          
          
            — 
    License beneficiary.
    
          
        
    • 
      
        
  • 
          :node_id
          (String)
          
            
          
          
            — 
    Node ID.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


149

    		
    
      
# File 'sig/client.rbs', line 149

def checkout_license: (


    		
  





    
      

  

  
    #create_grant(params = {})  ⇒ Types::CreateGrantResponse 
  

  

  




  

    
Creates a grant for the specified license. A grant shares the use of
license entitlements with a specific Amazon Web Services account, an
organization, or an organizational unit (OU). For more information,
see Granted licenses in License Manager in the License Manager
User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_grant({
  client_token: "ClientToken", # required
  grant_name: "String", # required
  license_arn: "Arn", # required
  principals: ["Arn"], # required
  home_region: "String", # required
  allowed_operations: ["CreateGrant"], # required, accepts CreateGrant, CheckoutLicense, CheckoutBorrowLicense, CheckInLicense, ExtendConsumptionLicense, ListPurchasedLicenses, CreateToken
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})


    
      
        
Response structure

      
      

resp.grant_arn #=> String
resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :grant_name
          (required, String)
          
            
          
          
            — 
    Grant name.
    
          
        
    • 
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
        
  • 
          :principals
          (required, Array<String>)
          
            
          
          
            — 
    The grant principals. You can specify one of the following as an
Amazon Resource Name (ARN):
    

      

    • An Amazon Web Services account, which includes only the account
specified.
      • 

    

    ^
^
    

      

    • An organizational unit (OU), which includes all accounts in the OU.
      • 

    

    ^
^
    

      

    • An organization, which will include all accounts across your
organization.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :home_region
          (required, String)
          
            
          
          
            — 
    Home Region of the grant.
    
          
        
    • 
      
        
  • 
          :allowed_operations
          (required, Array<String>)
          
            
          
          
            — 
    Allowed operations for the grant.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to add to the grant. For more information about tagging support
in License Manager, see the TagResource operation.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


173

    		
    
      
# File 'sig/client.rbs', line 173

def create_grant: (


    		
  





    
      

  

  
    #create_grant_version(params = {})  ⇒ Types::CreateGrantVersionResponse 
  

  

  




  

    
Creates a new version of the specified grant. For more information,
see Granted licenses in License Manager in the License Manager
User Guide.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_grant_version({
  client_token: "ClientToken", # required
  grant_arn: "Arn", # required
  grant_name: "String",
  allowed_operations: ["CreateGrant"], # accepts CreateGrant, CheckoutLicense, CheckoutBorrowLicense, CheckInLicense, ExtendConsumptionLicense, ListPurchasedLicenses, CreateToken
  status: "PENDING_WORKFLOW", # accepts PENDING_WORKFLOW, PENDING_ACCEPT, REJECTED, ACTIVE, FAILED_WORKFLOW, DELETED, PENDING_DELETE, DISABLED, WORKFLOW_COMPLETED
  status_reason: "StatusReasonMessage",
  source_version: "String",
  options: {
    activation_override_behavior: "DISTRIBUTED_GRANTS_ONLY", # accepts DISTRIBUTED_GRANTS_ONLY, ALL_GRANTS_PERMITTED_BY_ISSUER
  },
})


    
      
        
Response structure

      
      

resp.grant_arn #=> String
resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :grant_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the grant.
    
          
        
    • 
      
        
  • 
          :grant_name
          (String)
          
            
          
          
            — 
    Grant name.
    
          
        
    • 
      
        
  • 
          :allowed_operations
          (Array<String>)
          
            
          
          
            — 
    Allowed operations for the grant.
    
          
        
    • 
      
        
  • 
          :status
          (String)
          
            
          
          
            — 
    Grant status.
    
          
        
    • 
      
        
  • 
          :status_reason
          (String)
          
            
          
          
            — 
    Grant status reason.
    
          
        
    • 
      
        
  • 
          :source_version
          (String)
          
            
          
          
            — 
    Current version of the grant.
    
          
        
    • 
      
        
  • 
          :options
          (Types::Options)
          
            
          
          
            — 
    The options specified for the grant.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


196

    		
    
      
# File 'sig/client.rbs', line 196

def create_grant_version: (


    		
  





    
      

  

  
    #create_license(params = {})  ⇒ Types::CreateLicenseResponse 
  

  

  




  

    
Creates a license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license({
  license_name: "String", # required
  product_name: "String", # required
  product_sku: "String", # required
  issuer: { # required
    name: "String", # required
    sign_key: "String",
  },
  home_region: "String", # required
  validity: { # required
    begin: "ISO8601DateTime", # required
    end: "ISO8601DateTime",
  },
  entitlements: [ # required
    {
      name: "String", # required
      value: "String",
      max_count: 1,
      overage: false,
      unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
      allow_check_in: false,
    },
  ],
  beneficiary: "String", # required
  consumption_configuration: { # required
    renew_type: "None", # accepts None, Weekly, Monthly
    provisional_configuration: {
      max_time_to_live_in_minutes: 1, # required
    },
    borrow_configuration: {
      allow_early_check_in: false, # required
      max_time_to_live_in_minutes: 1, # required
    },
  },
  license_metadata: [
    {
      name: "String",
      value: "String",
    },
  ],
  client_token: "ClientToken", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})


    
      
        
Response structure

      
      

resp.license_arn #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_name
          (required, String)
          
            
          
          
            — 
    License name.
    
          
        
    • 
      
        
  • 
          :product_name
          (required, String)
          
            
          
          
            — 
    Product name.
    
          
        
    • 
      
        
  • 
          :product_sku
          (required, String)
          
            
          
          
            — 
    Product SKU.
    
          
        
    • 
      
        
  • 
          :issuer
          (required, Types::Issuer)
          
            
          
          
            — 
    License issuer.
    
          
        
    • 
      
        
  • 
          :home_region
          (required, String)
          
            
          
          
            — 
    Home Region for the license.
    
          
        
    • 
      
        
  • 
          :validity
          (required, Types::DatetimeRange)
          
            
          
          
            — 
    Date and time range during which the license is valid, in ISO8601-UTC
format.
    
          
        
    • 
      
        
  • 
          :entitlements
          (required, Array<Types::Entitlement>)
          
            
          
          
            — 
    License entitlements.
    
          
        
    • 
      
        
  • 
          :beneficiary
          (required, String)
          
            
          
          
            — 
    License beneficiary.
    
          
        
    • 
      
        
  • 
          :consumption_configuration
          (required, Types::ConsumptionConfiguration)
          
            
          
          
            — 
    Configuration for consumption of the license. Choose a provisional
configuration for workloads running with continuous connectivity.
Choose a borrow configuration for workloads with offline usage.
    
          
        
    • 
      
        
  • 
          :license_metadata
          (Array<Types::Metadata>)
          
            
          
          
            — 
    Information about the license.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to add to the license. For more information about tagging support
in License Manager, see the TagResource operation.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


217

    		
    
      
# File 'sig/client.rbs', line 217

def create_license: (


    		
  





    
      

  

  
    #create_license_asset_group(params = {})  ⇒ Types::CreateLicenseAssetGroupResponse 
  

  

  




  

    
Creates a license asset group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license_asset_group({
  name: "LicenseAssetResourceName", # required
  description: "LicenseAssetResourceDescription",
  license_asset_group_configurations: [ # required
    {
      usage_dimension: "String",
    },
  ],
  associated_license_asset_ruleset_arns: ["Arn"], # required
  properties: [
    {
      key: "String", # required
      value: "String", # required
    },
  ],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  client_token: "String", # required
})


    
      
        
Response structure

      
      

resp.license_asset_group_arn #=> String
resp.status #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    License asset group name.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    License asset group description.
    
          
        
    • 
      
        
  • 
          :license_asset_group_configurations
          (required, Array<Types::LicenseAssetGroupConfiguration>)
          
            
          
          
            — 
    License asset group configurations.
    
          
        
    • 
      
        
  • 
          :associated_license_asset_ruleset_arns
          (required, Array<String>)
          
            
          
          
            — 
    ARNs of associated license asset rulesets.
    
          
        
    • 
      
        
  • 
          :properties
          (Array<Types::LicenseAssetGroupProperty>)
          
            
          
          
            — 
    License asset group properties.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to add to the license asset group.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


257

    		
    
      
# File 'sig/client.rbs', line 257

def create_license_asset_group: (


    		
  





    
      

  

  
    #create_license_asset_ruleset(params = {})  ⇒ Types::CreateLicenseAssetRulesetResponse 
  

  

  




  

    
Creates a license asset ruleset.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license_asset_ruleset({
  name: "LicenseAssetResourceName", # required
  description: "LicenseAssetResourceDescription",
  rules: [ # required
    {
      rule_statement: { # required
        license_configuration_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
        },
        license_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
        },
        instance_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
          script_rule_statement: {
            key_to_match: "String", # required
            script: "String", # required
          },
        },
      },
    },
  ],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  client_token: "String", # required
})


    
      
        
Response structure

      
      

resp.license_asset_ruleset_arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (required, String)
          
            
          
          
            — 
    License asset ruleset name.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    License asset ruleset description.
    
          
        
    • 
      
        
  • 
          :rules
          (required, Array<Types::LicenseAssetRule>)
          
            
          
          
            — 
    License asset rules.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to add to the license asset ruleset.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


287

    		
    
      
# File 'sig/client.rbs', line 287

def create_license_asset_ruleset: (


    		
  





    
      

  

  
    #create_license_configuration(params = {})  ⇒ 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",
    },
  ],
  disassociate_when_not_found: false,
  product_information_list: [
    {
      resource_type: "String", # required
      product_information_filter_list: [ # required
        {
          product_information_filter_name: "String", # required
          product_information_filter_value: ["String"],
          product_information_filter_comparator: "String", # required
        },
      ],
    },
  ],
  license_expiry: 1,
})


    
      
        
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)
          
            
          
          
            — 
    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 | 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.
    
          
        
    • 
      
        
  • 
          :disassociate_when_not_found
          (Boolean)
          
            
          
          
            — 
    When true, disassociates a resource when software is uninstalled.
    
          
        
    • 
      
        
  • 
          :product_information_list
          (Array<Types::ProductInformation>)
          
            
          
          
            — 
    Product information.
    
          
        
    • 
      
        
  • 
          :license_expiry
          (Integer)
          
            
          
          
            — 
    License configuration expiry.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


308

    		
    
      
# File 'sig/client.rbs', line 308

def create_license_configuration: (


    		
  





    
      

  

  
    #create_license_conversion_task_for_resource(params = {})  ⇒ Types::CreateLicenseConversionTaskForResourceResponse 
  

  

  




  

    
Creates a new license conversion task.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license_conversion_task_for_resource({
  resource_arn: "Arn", # required
  source_license_context: { # required
    usage_operation: "UsageOperation",
    product_codes: [
      {
        product_code_id: "ProductCodeId", # required
        product_code_type: "marketplace", # required, accepts marketplace
      },
    ],
  },
  destination_license_context: { # required
    usage_operation: "UsageOperation",
    product_codes: [
      {
        product_code_id: "ProductCodeId", # required
        product_code_type: "marketplace", # required, accepts marketplace
      },
    ],
  },
})


    
      
        
Response structure

      
      

resp.license_conversion_task_id #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
  
    
    


Returns:



  
See Also:

  



  

    
      


334

    		
    
      
# File 'sig/client.rbs', line 334

def create_license_conversion_task_for_resource: (


    		
  





    
      

  

  
    #create_license_manager_report_generator(params = {})  ⇒ Types::CreateLicenseManagerReportGeneratorResponse 
  

  

  




  

    
Creates a report generator.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license_manager_report_generator({
  report_generator_name: "ReportGeneratorName", # required
  type: ["LicenseConfigurationSummaryReport"], # required, accepts LicenseConfigurationSummaryReport, LicenseConfigurationUsageReport, LicenseAssetGroupUsageReport
  report_context: { # required
    license_configuration_arns: ["Arn"],
    license_asset_group_arns: ["Arn"],
    report_start_date: Time.now,
    report_end_date: Time.now,
  },
  report_frequency: { # required
    value: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH, ONE_TIME
  },
  client_token: "ClientRequestToken", # required
  description: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})


    
      
        
Response structure

      
      

resp.license_manager_report_generator_arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :report_generator_name
          (required, String)
          
            
          
          
            — 
    Name of the report generator.
    
          
        
    • 
      
        
  • 
          :type
          (required, Array<String>)
          
            
          
          
            — 
    Type of reports to generate. The following report types an be
generated:
    

      

    • 

      License configuration report - Reports the number and details of
consumed licenses for a license configuration.
      

      • 

    • 

      Resource report - Reports the tracked licenses and resource
consumption for a license configuration.
      

      • 

    
          
        
    • 
      
        
  • 
          :report_context
          (required, Types::ReportContext)
          
            
          
          
            — 
    Defines the type of license configuration the report generator tracks.
    
          
        
    • 
      
        
  • 
          :report_frequency
          (required, Types::ReportFrequency)
          
            
          
          
            — 
    Frequency by which reports are generated. Reports can be generated
daily, monthly, or weekly.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    Description of the report generator.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to add to the report generator.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


362

    		
    
      
# File 'sig/client.rbs', line 362

def create_license_manager_report_generator: (


    		
  





    
      

  

  
    #create_license_version(params = {})  ⇒ Types::CreateLicenseVersionResponse 
  

  

  




  

    
Creates a new version of the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_license_version({
  license_arn: "Arn", # required
  license_name: "String", # required
  product_name: "String", # required
  issuer: { # required
    name: "String", # required
    sign_key: "String",
  },
  home_region: "String", # required
  validity: { # required
    begin: "ISO8601DateTime", # required
    end: "ISO8601DateTime",
  },
  license_metadata: [
    {
      name: "String",
      value: "String",
    },
  ],
  entitlements: [ # required
    {
      name: "String", # required
      value: "String",
      max_count: 1,
      overage: false,
      unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
      allow_check_in: false,
    },
  ],
  consumption_configuration: { # required
    renew_type: "None", # accepts None, Weekly, Monthly
    provisional_configuration: {
      max_time_to_live_in_minutes: 1, # required
    },
    borrow_configuration: {
      allow_early_check_in: false, # required
      max_time_to_live_in_minutes: 1, # required
    },
  },
  status: "AVAILABLE", # required, accepts AVAILABLE, PENDING_AVAILABLE, DEACTIVATED, SUSPENDED, EXPIRED, PENDING_DELETE, DELETED
  client_token: "ClientToken", # required
  source_version: "String",
  reset_usage: false,
})


    
      
        
Response structure

      
      

resp.license_arn #=> String
resp.version #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
        
  • 
          :license_name
          (required, String)
          
            
          
          
            — 
    License name.
    
          
        
    • 
      
        
  • 
          :product_name
          (required, String)
          
            
          
          
            — 
    Product name.
    
          
        
    • 
      
        
  • 
          :issuer
          (required, Types::Issuer)
          
            
          
          
            — 
    License issuer.
    
          
        
    • 
      
        
  • 
          :home_region
          (required, String)
          
            
          
          
            — 
    Home Region of the license.
    
          
        
    • 
      
        
  • 
          :validity
          (required, Types::DatetimeRange)
          
            
          
          
            — 
    Date and time range during which the license is valid, in ISO8601-UTC
format.
    
          
        
    • 
      
        
  • 
          :license_metadata
          (Array<Types::Metadata>)
          
            
          
          
            — 
    Information about the license.
    
          
        
    • 
      
        
  • 
          :entitlements
          (required, Array<Types::Entitlement>)
          
            
          
          
            — 
    License entitlements.
    
          
        
    • 
      
        
  • 
          :consumption_configuration
          (required, Types::ConsumptionConfiguration)
          
            
          
          
            — 
    Configuration for consumption of the license. Choose a provisional
configuration for workloads running with continuous connectivity.
Choose a borrow configuration for workloads with offline usage.
    
          
        
    • 
      
        
  • 
          :status
          (required, String)
          
            
          
          
            — 
    License status.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :source_version
          (String)
          
            
          
          
            — 
    Current version of the license.
    
          
        
    • 
      
        
  • 
          :reset_usage
          (Boolean)
          
            
          
          
            — 
    Specifies whether to reset the license usage for the new license
version. If you don't specify a value, the license usage is not
reset.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


393

    		
    
      
# File 'sig/client.rbs', line 393

def create_license_version: (


    		
  





    
      

  

  
    #create_token(params = {})  ⇒ Types::CreateTokenResponse 
  

  

  




  

    
Creates a long-lived token.


A refresh token is a JWT token used to get an access token. With an
access token, you can call AssumeRoleWithWebIdentity to get role
credentials that you can use to call License Manager to manage the
specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_token({
  license_arn: "Arn", # required
  role_arns: ["Arn"],
  expiration_in_days: 1,
  token_properties: ["String"],
  client_token: "ClientToken", # required
})


    
      
        
Response structure

      
      

resp.token_id #=> String
resp.token_type #=> String, one of "REFRESH_TOKEN"
resp.token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license. The ARN is mapped to the
aud claim of the JWT token.
    
          
        
    • 
      
        
  • 
          :role_arns
          (Array<String>)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the IAM roles to embed in the token.
License Manager does not check whether the roles are in use.
    
          
        
    • 
      
        
  • 
          :expiration_in_days
          (Integer)
          
            
          
          
            — 
    Token expiration, in days, counted from token creation. The default is
365 days.
    
          
        
    • 
      
        
  • 
          :token_properties
          (Array<String>)
          
            
          
          
            — 
    Data specified by the caller to be included in the JWT token. The data
is mapped to the amr claim of the JWT token.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Idempotency token, valid for 10 minutes.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


430

    		
    
      
# File 'sig/client.rbs', line 430

def create_token: (


    		
  





    
      

  

  
    #delete_grant(params = {})  ⇒ Types::DeleteGrantResponse 
  

  

  




  

    
Deletes the specified grant.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_grant({
  grant_arn: "Arn", # required
  status_reason: "StatusReasonMessage",
  version: "String", # required
})


    
      
        
Response structure

      
      

resp.grant_arn #=> String
resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the grant.
    
          
        
    • 
      
        
  • 
          :status_reason
          (String)
          
            
          
          
            — 
    The Status reason for the delete request.
    
          
        
    • 
      
        
  • 
          :version
          (required, String)
          
            
          
          
            — 
    Current version of the grant.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


446

    		
    
      
# File 'sig/client.rbs', line 446

def delete_grant: (


    		
  





    
      

  

  
    #delete_license(params = {})  ⇒ Types::DeleteLicenseResponse 
  

  

  




  

    
Deletes the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_license({
  license_arn: "Arn", # required
  source_version: "String", # required
})


    
      
        
Response structure

      
      

resp.status #=> String, one of "PENDING_DELETE", "DELETED"
resp.deletion_date #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
        
  • 
          :source_version
          (required, String)
          
            
          
          
            — 
    Current version of the license.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


459

    		
    
      
# File 'sig/client.rbs', line 459

def delete_license: (


    		
  





    
      

  

  
    #delete_license_asset_group(params = {})  ⇒ Types::DeleteLicenseAssetGroupResponse 
  

  

  




  

    
Deletes a license asset group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_license_asset_group({
  license_asset_group_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.status #=> String, one of "ACTIVE", "DISABLED", "DELETED"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_asset_group_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


470

    		
    
      
# File 'sig/client.rbs', line 470

def delete_license_asset_group: (


    		
  





    
      

  

  
    #delete_license_asset_ruleset(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes a license asset ruleset.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_license_asset_ruleset({
  license_asset_ruleset_arn: "Arn", # required
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_asset_ruleset_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset ruleset.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


479

    		
    
      
# File 'sig/client.rbs', line 479

def delete_license_asset_ruleset: (


    		
  





    
      

  

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_configuration_arn
          (required, String)
          
            
          
          
            — 
    ID of the license configuration.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


488

    		
    
      
# File 'sig/client.rbs', line 488

def delete_license_configuration: (


    		
  





    
      

  

  
    #delete_license_manager_report_generator(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified report generator.


This action deletes the report generator, which stops it from
generating future reports. The action cannot be reversed. It has no
effect on the previous reports from this generator.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_license_manager_report_generator({
  license_manager_report_generator_arn: "String", # required
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_manager_report_generator_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the report generator to be deleted.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


497

    		
    
      
# File 'sig/client.rbs', line 497

def delete_license_manager_report_generator: (


    		
  





    
      

  

  
    #delete_token(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified token. Must be called in the license home
Region.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_token({
  token_id: "String", # required
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :token_id
          (required, String)
          
            
          
          
            — 
    Token ID.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


506

    		
    
      
# File 'sig/client.rbs', line 506

def delete_token: (


    		
  





    
      

  

  
    #extend_license_consumption(params = {})  ⇒ Types::ExtendLicenseConsumptionResponse 
  

  

  




  

    
Extends the expiration date for license consumption.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.extend_license_consumption({
  license_consumption_token: "String", # required
  dry_run: false,
})


    
      
        
Response structure

      
      

resp.license_consumption_token #=> String
resp.expiration #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_consumption_token
          (required, String)
          
            
          
          
            — 
    License consumption token.
    
          
        
    • 
      
        
  • 
          :dry_run
          (Boolean)
          
            
          
          
            — 
    Checks whether you have the required permissions for the action,
without actually making the request. Provides an error response if you
do not have the required permissions.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


517

    		
    
      
# File 'sig/client.rbs', line 517

def extend_license_consumption: (


    		
  





    
      

  

  
    #get_access_token(params = {})  ⇒ Types::GetAccessTokenResponse 
  

  

  




  

    
Gets a temporary access token to use with AssumeRoleWithWebIdentity.
Access tokens are valid for one hour.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_access_token({
  token: "TokenString", # required
  token_properties: ["String"],
})


    
      
        
Response structure

      
      

resp.access_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :token
          (required, String)
          
            
          
          
            — 
    Refresh token, encoded as a JWT token.
    
          
        
    • 
      
        
  • 
          :token_properties
          (Array<String>)
          
            
          
          
            — 
    Token properties to validate against those present in the JWT token.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


528

    		
    
      
# File 'sig/client.rbs', line 528

def get_access_token: (


    		
  





    
      

  

  
    #get_grant(params = {})  ⇒ Types::GetGrantResponse 
  

  

  




  

    
Gets detailed information about the specified grant.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_grant({
  grant_arn: "Arn", # required
  version: "String",
})


    
      
        
Response structure

      
      

resp.grant.grant_arn #=> String
resp.grant.grant_name #=> String
resp.grant.parent_arn #=> String
resp.grant.license_arn #=> String
resp.grant.grantee_principal_arn #=> String
resp.grant.home_region #=> String
resp.grant.grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.grant.status_reason #=> String
resp.grant.version #=> String
resp.grant.granted_operations #=> Array
resp.grant.granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.grant.options.activation_override_behavior #=> String, one of "DISTRIBUTED_GRANTS_ONLY", "ALL_GRANTS_PERMITTED_BY_ISSUER"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the grant.
    
          
        
    • 
      
        
  • 
          :version
          (String)
          
            
          
          
            — 
    Grant version.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


539

    		
    
      
# File 'sig/client.rbs', line 539

def get_grant: (


    		
  





    
      

  

  
    #get_license(params = {})  ⇒ Types::GetLicenseResponse 
  

  

  




  

    
Gets detailed information about the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license({
  license_arn: "Arn", # required
  version: "String",
})


    
      
        
Response structure

      
      

resp.license.license_arn #=> String
resp.license.license_name #=> String
resp.license.product_name #=> String
resp.license.product_sku #=> String
resp.license.issuer.name #=> String
resp.license.issuer.sign_key #=> String
resp.license.issuer.key_fingerprint #=> String
resp.license.home_region #=> String
resp.license.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.license.validity.begin #=> String
resp.license.validity.end #=> String
resp.license.beneficiary #=> String
resp.license.entitlements #=> Array
resp.license.entitlements[0].name #=> String
resp.license.entitlements[0].value #=> String
resp.license.entitlements[0].max_count #=> Integer
resp.license.entitlements[0].overage #=> Boolean
resp.license.entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.license.entitlements[0].allow_check_in #=> Boolean
resp.license.consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
resp.license.consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
resp.license.consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
resp.license.consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
resp.license.license_metadata #=> Array
resp.license.license_metadata[0].name #=> String
resp.license.license_metadata[0].value #=> String
resp.license.create_time #=> String
resp.license.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
        
  • 
          :version
          (String)
          
            
          
          
            — 
    License version.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


550

    		
    
      
# File 'sig/client.rbs', line 550

def get_license: (


    		
  





    
      

  

  
    #get_license_asset_group(params = {})  ⇒ Types::GetLicenseAssetGroupResponse 
  

  

  




  

    
Gets a license asset group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license_asset_group({
  license_asset_group_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.license_asset_group.name #=> String
resp.license_asset_group.description #=> String
resp.license_asset_group.license_asset_group_configurations #=> Array
resp.license_asset_group.license_asset_group_configurations[0].usage_dimension #=> String
resp.license_asset_group.associated_license_asset_ruleset_arns #=> Array
resp.license_asset_group.associated_license_asset_ruleset_arns[0] #=> String
resp.license_asset_group.properties #=> Array
resp.license_asset_group.properties[0].key #=> String
resp.license_asset_group.properties[0].value #=> String
resp.license_asset_group.license_asset_group_arn #=> String
resp.license_asset_group.status #=> String, one of "ACTIVE", "DISABLED", "DELETED"
resp.license_asset_group.status_message #=> String
resp.license_asset_group.latest_usage_analysis_time #=> Time
resp.license_asset_group.latest_resource_discovery_time #=> Time


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_asset_group_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


561

    		
    
      
# File 'sig/client.rbs', line 561

def get_license_asset_group: (


    		
  





    
      

  

  
    #get_license_asset_ruleset(params = {})  ⇒ Types::GetLicenseAssetRulesetResponse 
  

  

  




  

    
Gets a license asset ruleset.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license_asset_ruleset({
  license_asset_ruleset_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.license_asset_ruleset.name #=> String
resp.license_asset_ruleset.description #=> String
resp.license_asset_ruleset.rules #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.license_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.script_rule_statement.key_to_match #=> String
resp.license_asset_ruleset.rules[0].rule_statement.instance_rule_statement.script_rule_statement.script #=> String
resp.license_asset_ruleset.license_asset_ruleset_arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_asset_ruleset_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset ruleset.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


571

    		
    
      
# File 'sig/client.rbs', line 571

def get_license_asset_ruleset: (


    		
  





    
      

  

  
    #get_license_configuration(params = {})  ⇒ 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 #=> 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", "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
resp.disassociate_when_not_found #=> Boolean
resp.license_expiry #=> Integer


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_configuration_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


598

    		
    
      
# File 'sig/client.rbs', line 598

def get_license_configuration: (


    		
  





    
      

  

  
    #get_license_conversion_task(params = {})  ⇒ Types::GetLicenseConversionTaskResponse 
  

  

  




  

    
Gets information about the specified license type conversion task.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license_conversion_task({
  license_conversion_task_id: "LicenseConversionTaskId", # required
})


    
      
        
Response structure

      
      

resp.license_conversion_task_id #=> String
resp.resource_arn #=> String
resp.source_license_context.usage_operation #=> String
resp.source_license_context.product_codes #=> Array
resp.source_license_context.product_codes[0].product_code_id #=> String
resp.source_license_context.product_codes[0].product_code_type #=> String, one of "marketplace"
resp.destination_license_context.usage_operation #=> String
resp.destination_license_context.product_codes #=> Array
resp.destination_license_context.product_codes[0].product_code_id #=> String
resp.destination_license_context.product_codes[0].product_code_type #=> String, one of "marketplace"
resp.status_message #=> String
resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.start_time #=> Time
resp.license_conversion_time #=> Time
resp.end_time #=> Time


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_conversion_task_id
          (required, String)
          
            
          
          
            — 
    ID of the license type conversion task to retrieve information on.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


616

    		
    
      
# File 'sig/client.rbs', line 616

def get_license_conversion_task: (


    		
  





    
      

  

  
    #get_license_manager_report_generator(params = {})  ⇒ Types::GetLicenseManagerReportGeneratorResponse 
  

  

  




  

    
Gets information about the specified report generator.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license_manager_report_generator({
  license_manager_report_generator_arn: "String", # required
})


    
      
        
Response structure

      
      

resp.report_generator.report_generator_name #=> String
resp.report_generator.report_type #=> Array
resp.report_generator.report_type[0] #=> String, one of "LicenseConfigurationSummaryReport", "LicenseConfigurationUsageReport", "LicenseAssetGroupUsageReport"
resp.report_generator.report_context.license_configuration_arns #=> Array
resp.report_generator.report_context.license_configuration_arns[0] #=> String
resp.report_generator.report_context.license_asset_group_arns #=> Array
resp.report_generator.report_context.license_asset_group_arns[0] #=> String
resp.report_generator.report_context.report_start_date #=> Time
resp.report_generator.report_context.report_end_date #=> Time
resp.report_generator.report_frequency.value #=> Integer
resp.report_generator.report_frequency.period #=> String, one of "DAY", "WEEK", "MONTH", "ONE_TIME"
resp.report_generator.license_manager_report_generator_arn #=> String
resp.report_generator.last_run_status #=> String
resp.report_generator.last_run_failure_reason #=> String
resp.report_generator.last_report_generation_time #=> String
resp.report_generator. #=> String
resp.report_generator.description #=> String
resp.report_generator.s3_location.bucket #=> String
resp.report_generator.s3_location.key_prefix #=> String
resp.report_generator.create_time #=> String
resp.report_generator.tags #=> Array
resp.report_generator.tags[0].key #=> String
resp.report_generator.tags[0].value #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_manager_report_generator_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the report generator.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


626

    		
    
      
# File 'sig/client.rbs', line 626

def get_license_manager_report_generator: (


    		
  





    
      

  

  
    #get_license_usage(params = {})  ⇒ Types::GetLicenseUsageResponse 
  

  

  




  

    
Gets detailed information about the usage of the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.get_license_usage({
  license_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.license_usage.entitlement_usages #=> Array
resp.license_usage.entitlement_usages[0].name #=> String
resp.license_usage.entitlement_usages[0].consumed_value #=> String
resp.license_usage.entitlement_usages[0].max_count #=> String
resp.license_usage.entitlement_usages[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


636

    		
    
      
# File 'sig/client.rbs', line 636

def get_license_usage: (


    		
  





    
      

  

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

  

  




  

    
Gets the License Manager settings for the current Region.


  





  
  

    
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
resp.license_manager_resource_share_arn #=> String
resp.cross_region_discovery_home_region #=> String
resp.cross_region_discovery_source_regions #=> Array
resp.cross_region_discovery_source_regions[0] #=> String
resp.service_status..message #=> String
resp.service_status.cross_region_discovery.message #=> Hash
resp.service_status.cross_region_discovery.message["String"].status #=> String


    
  


  

Parameters:


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




Returns:



  
See Also:

  



  

    
      


653

    		
    
      
# File 'sig/client.rbs', line 653

def get_service_settings: (


    		
  





    
      

  

  
    #list_assets_for_license_asset_group(params = {})  ⇒ Types::ListAssetsForLicenseAssetGroupResponse 
  

  

  




  

    
Lists assets for a license asset group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_assets_for_license_asset_group({
  license_asset_group_arn: "String", # required
  asset_type: "String", # required
  max_results: 1,
  next_token: "String",
})


    
      
        
Response structure

      
      

resp.assets #=> Array
resp.assets[0].asset_arn #=> String
resp.assets[0].latest_asset_discovery_time #=> Time
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_asset_group_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset group.
    
          
        
    • 
      
        
  • 
          :asset_type
          (required, String)
          
            
          
          
            — 
    Asset type. The possible values are Instance | License |
LicenseConfiguration.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


663

    		
    
      
# File 'sig/client.rbs', line 663

def list_assets_for_license_asset_group: (


    		
  





    
      

  

  
    #list_associations_for_license_configuration(params = {})  ⇒ 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.license_configuration_associations[0].ami_association_scope #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  



  

    
      


677

    		
    
      
# File 'sig/client.rbs', line 677

def list_associations_for_license_configuration: (


    		
  





    
      

  

  
    #list_distributed_grants(params = {})  ⇒ Types::ListDistributedGrantsResponse 
  

  

  




  

    
Lists the grants distributed for the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.grants #=> Array
resp.grants[0].grant_arn #=> String
resp.grants[0].grant_name #=> String
resp.grants[0].parent_arn #=> String
resp.grants[0].license_arn #=> String
resp.grants[0].grantee_principal_arn #=> String
resp.grants[0].home_region #=> String
resp.grants[0].grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.grants[0].status_reason #=> String
resp.grants[0].version #=> String
resp.grants[0].granted_operations #=> Array
resp.grants[0].granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.grants[0].options.activation_override_behavior #=> String, one of "DISTRIBUTED_GRANTS_ONLY", "ALL_GRANTS_PERMITTED_BY_ISSUER"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arns
          (Array<String>)
          
            
          
          
            — 
    Amazon Resource Names (ARNs) of the grants.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      LicenseArn
      

      • 

    • 

      GrantStatus
      

      • 

    • 

      GranteePrincipalARN
      

      • 

    • 

      ProductSKU
      

      • 

    • 

      LicenseIssuerName
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


690

    		
    
      
# File 'sig/client.rbs', line 690

def list_distributed_grants: (


    		
  





    
      

  

  
    #list_failures_for_license_configuration_operations(params = {})  ⇒ 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].metadata_list #=> Array
resp.license_operation_failure_list[0].metadata_list[0].name #=> String
resp.license_operation_failure_list[0].metadata_list[0].value #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  



  

    
      


709

    		
    
      
# File 'sig/client.rbs', line 709

def list_failures_for_license_configuration_operations: (


    		
  





    
      

  

  
    #list_license_asset_groups(params = {})  ⇒ Types::ListLicenseAssetGroupsResponse 
  

  

  




  

    
Lists license asset groups.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.license_asset_groups #=> Array
resp.license_asset_groups[0].name #=> String
resp.license_asset_groups[0].description #=> String
resp.license_asset_groups[0].license_asset_group_configurations #=> Array
resp.license_asset_groups[0].license_asset_group_configurations[0].usage_dimension #=> String
resp.license_asset_groups[0].associated_license_asset_ruleset_arns #=> Array
resp.license_asset_groups[0].associated_license_asset_ruleset_arns[0] #=> String
resp.license_asset_groups[0].properties #=> Array
resp.license_asset_groups[0].properties[0].key #=> String
resp.license_asset_groups[0].properties[0].value #=> String
resp.license_asset_groups[0].license_asset_group_arn #=> String
resp.license_asset_groups[0].status #=> String, one of "ACTIVE", "DISABLED", "DELETED"
resp.license_asset_groups[0].status_message #=> String
resp.license_asset_groups[0].latest_usage_analysis_time #=> Time
resp.license_asset_groups[0].latest_resource_discovery_time #=> Time
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. Following filters are supported
    

      

    • LicenseAssetRulesetArn
      • 

    

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

  



  

    
      


722

    		
    
      
# File 'sig/client.rbs', line 722

def list_license_asset_groups: (


    		
  





    
      

  

  
    #list_license_asset_rulesets(params = {})  ⇒ Types::ListLicenseAssetRulesetsResponse 
  

  

  




  

    
Lists license asset rulesets.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.license_asset_rulesets #=> Array
resp.license_asset_rulesets[0].name #=> String
resp.license_asset_rulesets[0].description #=> String
resp.license_asset_rulesets[0].rules #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_configuration_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.license_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.and_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.matching_rule_statements[0].value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements[0].key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.or_rule_statement.script_rule_statements[0].script #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.matching_rule_statement.key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.matching_rule_statement.constraint #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.matching_rule_statement.value_to_match #=> Array
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.matching_rule_statement.value_to_match[0] #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.script_rule_statement.key_to_match #=> String
resp.license_asset_rulesets[0].rules[0].rule_statement.instance_rule_statement.script_rule_statement.script #=> String
resp.license_asset_rulesets[0].license_asset_ruleset_arn #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. Following filters are supported
    

      

    • Name
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :show_aws_managed_license_asset_rulesets
          (Boolean)
          
            
          
          
            — 
    Specifies whether to show License Manager managed license asset
rulesets.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


740

    		
    
      
# File 'sig/client.rbs', line 740

def list_license_asset_rulesets: (


    		
  





    
      

  

  
    #list_license_configurations(params = {})  ⇒ 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 #=> Boolean
resp.license_configurations[0].disassociate_when_not_found #=> 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", "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.license_configurations[0].license_expiry #=> Integer
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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 for which licenses are
counted. Possible values are vCPU | Instance | Core |
Socket.
      

      • 

    • 

      enforceLicenseCount - A Boolean value that indicates whether hard
license enforcement is used.
      

      • 

    • 

      usagelimitExceeded - A Boolean value that indicates whether the
available licenses have been exceeded.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


759

    		
    
      
# File 'sig/client.rbs', line 759

def list_license_configurations: (


    		
  





    
      

  

  
    #list_license_configurations_for_organization(params = {})  ⇒ Types::ListLicenseConfigurationsForOrganizationResponse 
  

  

  




  

    
Lists license configurations for an organization.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_license_configurations_for_organization({
  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].disassociate_when_not_found #=> 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", "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.license_configurations[0].license_expiry #=> Integer
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_configuration_arns
          (Array<String>)
          
            
          
          
            — 
    License configuration ARNs.
    
          
        
    • 
      
        
  • 
          :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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


778

    		
    
      
# File 'sig/client.rbs', line 778

def list_license_configurations_for_organization: (


    		
  





    
      

  

  
    #list_license_conversion_tasks(params = {})  ⇒ Types::ListLicenseConversionTasksResponse 
  

  

  




  

    
Lists the license type conversion tasks for your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.license_conversion_tasks #=> Array
resp.license_conversion_tasks[0].license_conversion_task_id #=> String
resp.license_conversion_tasks[0].resource_arn #=> String
resp.license_conversion_tasks[0].source_license_context.usage_operation #=> String
resp.license_conversion_tasks[0].source_license_context.product_codes #=> Array
resp.license_conversion_tasks[0].source_license_context.product_codes[0].product_code_id #=> String
resp.license_conversion_tasks[0].source_license_context.product_codes[0].product_code_type #=> String, one of "marketplace"
resp.license_conversion_tasks[0].destination_license_context.usage_operation #=> String
resp.license_conversion_tasks[0].destination_license_context.product_codes #=> Array
resp.license_conversion_tasks[0].destination_license_context.product_codes[0].product_code_id #=> String
resp.license_conversion_tasks[0].destination_license_context.product_codes[0].product_code_type #=> String, one of "marketplace"
resp.license_conversion_tasks[0].status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.license_conversion_tasks[0].status_message #=> String
resp.license_conversion_tasks[0].start_time #=> Time
resp.license_conversion_tasks[0].license_conversion_time #=> Time
resp.license_conversion_tasks[0].end_time #=> Time
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. Valid filters are ResourceArns and
Status.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


797

    		
    
      
# File 'sig/client.rbs', line 797

def list_license_conversion_tasks: (


    		
  





    
      

  

  
    #list_license_manager_report_generators(params = {})  ⇒ Types::ListLicenseManagerReportGeneratorsResponse 
  

  

  




  

    
Lists the report generators for your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.report_generators #=> Array
resp.report_generators[0].report_generator_name #=> String
resp.report_generators[0].report_type #=> Array
resp.report_generators[0].report_type[0] #=> String, one of "LicenseConfigurationSummaryReport", "LicenseConfigurationUsageReport", "LicenseAssetGroupUsageReport"
resp.report_generators[0].report_context.license_configuration_arns #=> Array
resp.report_generators[0].report_context.license_configuration_arns[0] #=> String
resp.report_generators[0].report_context.license_asset_group_arns #=> Array
resp.report_generators[0].report_context.license_asset_group_arns[0] #=> String
resp.report_generators[0].report_context.report_start_date #=> Time
resp.report_generators[0].report_context.report_end_date #=> Time
resp.report_generators[0].report_frequency.value #=> Integer
resp.report_generators[0].report_frequency.period #=> String, one of "DAY", "WEEK", "MONTH", "ONE_TIME"
resp.report_generators[0].license_manager_report_generator_arn #=> String
resp.report_generators[0].last_run_status #=> String
resp.report_generators[0].last_run_failure_reason #=> String
resp.report_generators[0].last_report_generation_time #=> String
resp.report_generators[0]. #=> String
resp.report_generators[0].description #=> String
resp.report_generators[0].s3_location.bucket #=> String
resp.report_generators[0].s3_location.key_prefix #=> String
resp.report_generators[0].create_time #=> String
resp.report_generators[0].tags #=> Array
resp.report_generators[0].tags[0].key #=> String
resp.report_generators[0].tags[0].value #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • LicenseConfigurationArn
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


815

    		
    
      
# File 'sig/client.rbs', line 815

def list_license_manager_report_generators: (


    		
  





    
      

  

  
    #list_license_specifications_for_resource(params = {})  ⇒ 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.license_specifications[0].ami_association_scope #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  



  

    
      


833

    		
    
      
# File 'sig/client.rbs', line 833

def list_license_specifications_for_resource: (


    		
  





    
      

  

  
    #list_license_versions(params = {})  ⇒ Types::ListLicenseVersionsResponse 
  

  

  




  

    
Lists all versions of the specified license.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_license_versions({
  license_arn: "Arn", # required
  next_token: "String",
  max_results: 1,
})


    
      
        
Response structure

      
      

resp.licenses #=> Array
resp.licenses[0].license_arn #=> String
resp.licenses[0].license_name #=> String
resp.licenses[0].product_name #=> String
resp.licenses[0].product_sku #=> String
resp.licenses[0].issuer.name #=> String
resp.licenses[0].issuer.sign_key #=> String
resp.licenses[0].issuer.key_fingerprint #=> String
resp.licenses[0].home_region #=> String
resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.licenses[0].validity.begin #=> String
resp.licenses[0].validity.end #=> String
resp.licenses[0].beneficiary #=> String
resp.licenses[0].entitlements #=> Array
resp.licenses[0].entitlements[0].name #=> String
resp.licenses[0].entitlements[0].value #=> String
resp.licenses[0].entitlements[0].max_count #=> Integer
resp.licenses[0].entitlements[0].overage #=> Boolean
resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].license_metadata #=> Array
resp.licenses[0].license_metadata[0].name #=> String
resp.licenses[0].license_metadata[0].value #=> String
resp.licenses[0].create_time #=> String
resp.licenses[0].version #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


846

    		
    
      
# File 'sig/client.rbs', line 846

def list_license_versions: (


    		
  





    
      

  

  
    #list_licenses(params = {})  ⇒ Types::ListLicensesResponse 
  

  

  




  

    
Lists the licenses for your account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.licenses #=> Array
resp.licenses[0].license_arn #=> String
resp.licenses[0].license_name #=> String
resp.licenses[0].product_name #=> String
resp.licenses[0].product_sku #=> String
resp.licenses[0].issuer.name #=> String
resp.licenses[0].issuer.sign_key #=> String
resp.licenses[0].issuer.key_fingerprint #=> String
resp.licenses[0].home_region #=> String
resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.licenses[0].validity.begin #=> String
resp.licenses[0].validity.end #=> String
resp.licenses[0].beneficiary #=> String
resp.licenses[0].entitlements #=> Array
resp.licenses[0].entitlements[0].name #=> String
resp.licenses[0].entitlements[0].value #=> String
resp.licenses[0].entitlements[0].max_count #=> Integer
resp.licenses[0].entitlements[0].overage #=> Boolean
resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].license_metadata #=> Array
resp.licenses[0].license_metadata[0].name #=> String
resp.licenses[0].license_metadata[0].value #=> String
resp.licenses[0].create_time #=> String
resp.licenses[0].version #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arns
          (Array<String>)
          
            
          
          
            — 
    Amazon Resource Names (ARNs) of the licenses.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      Beneficiary
      

      • 

    • 

      ProductSKU
      

      • 

    • 

      Fingerprint
      

      • 

    • 

      Status
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


859

    		
    
      
# File 'sig/client.rbs', line 859

def list_licenses: (


    		
  





    
      

  

  
    #list_received_grants(params = {})  ⇒ Types::ListReceivedGrantsResponse 
  

  

  




  

    
Lists grants that are received. Received grants are grants created
while specifying the recipient as this Amazon Web Services account,
your organization, or an organizational unit (OU) to which this member
account belongs.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.grants #=> Array
resp.grants[0].grant_arn #=> String
resp.grants[0].grant_name #=> String
resp.grants[0].parent_arn #=> String
resp.grants[0].license_arn #=> String
resp.grants[0].grantee_principal_arn #=> String
resp.grants[0].home_region #=> String
resp.grants[0].grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.grants[0].status_reason #=> String
resp.grants[0].version #=> String
resp.grants[0].granted_operations #=> Array
resp.grants[0].granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.grants[0].options.activation_override_behavior #=> String, one of "DISTRIBUTED_GRANTS_ONLY", "ALL_GRANTS_PERMITTED_BY_ISSUER"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arns
          (Array<String>)
          
            
          
          
            — 
    Amazon Resource Names (ARNs) of the grants.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      ProductSKU
      

      • 

    • 

      LicenseIssuerName
      

      • 

    • 

      LicenseArn
      

      • 

    • 

      GrantStatus
      

      • 

    • 

      GranterAccountId
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


878

    		
    
      
# File 'sig/client.rbs', line 878

def list_received_grants: (


    		
  





    
      

  

  
    #list_received_grants_for_organization(params = {})  ⇒ Types::ListReceivedGrantsForOrganizationResponse 
  

  

  




  

    
Lists the grants received for all accounts in the organization.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.grants #=> Array
resp.grants[0].grant_arn #=> String
resp.grants[0].grant_name #=> String
resp.grants[0].parent_arn #=> String
resp.grants[0].license_arn #=> String
resp.grants[0].grantee_principal_arn #=> String
resp.grants[0].home_region #=> String
resp.grants[0].grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.grants[0].status_reason #=> String
resp.grants[0].version #=> String
resp.grants[0].granted_operations #=> Array
resp.grants[0].granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.grants[0].options.activation_override_behavior #=> String, one of "DISTRIBUTED_GRANTS_ONLY", "ALL_GRANTS_PERMITTED_BY_ISSUER"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the received license.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      ParentArn
      

      • 

    • 

      GranteePrincipalArn
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


897

    		
    
      
# File 'sig/client.rbs', line 897

def list_received_grants_for_organization: (


    		
  





    
      

  

  
    #list_received_licenses(params = {})  ⇒ Types::ListReceivedLicensesResponse 
  

  

  




  

    
Lists received licenses.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.licenses #=> Array
resp.licenses[0].license_arn #=> String
resp.licenses[0].license_name #=> String
resp.licenses[0].product_name #=> String
resp.licenses[0].product_sku #=> String
resp.licenses[0].issuer.name #=> String
resp.licenses[0].issuer.sign_key #=> String
resp.licenses[0].issuer.key_fingerprint #=> String
resp.licenses[0].home_region #=> String
resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.licenses[0].validity.begin #=> String
resp.licenses[0].validity.end #=> String
resp.licenses[0].beneficiary #=> String
resp.licenses[0].entitlements #=> Array
resp.licenses[0].entitlements[0].name #=> String
resp.licenses[0].entitlements[0].value #=> String
resp.licenses[0].entitlements[0].max_count #=> Integer
resp.licenses[0].entitlements[0].overage #=> Boolean
resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].license_metadata #=> Array
resp.licenses[0].license_metadata[0].name #=> String
resp.licenses[0].license_metadata[0].value #=> String
resp.licenses[0].create_time #=> String
resp.licenses[0].version #=> String
resp.licenses[0].received_metadata.received_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "DISABLED", "WORKFLOW_COMPLETED"
resp.licenses[0].received_metadata.received_status_reason #=> String
resp.licenses[0].received_metadata.allowed_operations #=> Array
resp.licenses[0].received_metadata.allowed_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_arns
          (Array<String>)
          
            
          
          
            — 
    Amazon Resource Names (ARNs) of the licenses.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      ProductSKU
      

      • 

    • 

      Status
      

      • 

    • 

      Fingerprint
      

      • 

    • 

      IssuerName
      

      • 

    • 

      Beneficiary
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


916

    		
    
      
# File 'sig/client.rbs', line 916

def list_received_licenses: (


    		
  





    
      

  

  
    #list_received_licenses_for_organization(params = {})  ⇒ Types::ListReceivedLicensesForOrganizationResponse 
  

  

  




  

    
Lists the licenses received for all accounts in the organization.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.licenses #=> Array
resp.licenses[0].license_arn #=> String
resp.licenses[0].license_name #=> String
resp.licenses[0].product_name #=> String
resp.licenses[0].product_sku #=> String
resp.licenses[0].issuer.name #=> String
resp.licenses[0].issuer.sign_key #=> String
resp.licenses[0].issuer.key_fingerprint #=> String
resp.licenses[0].home_region #=> String
resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
resp.licenses[0].validity.begin #=> String
resp.licenses[0].validity.end #=> String
resp.licenses[0].beneficiary #=> String
resp.licenses[0].entitlements #=> Array
resp.licenses[0].entitlements[0].name #=> String
resp.licenses[0].entitlements[0].value #=> String
resp.licenses[0].entitlements[0].max_count #=> Integer
resp.licenses[0].entitlements[0].overage #=> Boolean
resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
resp.licenses[0].license_metadata #=> Array
resp.licenses[0].license_metadata[0].name #=> String
resp.licenses[0].license_metadata[0].value #=> String
resp.licenses[0].create_time #=> String
resp.licenses[0].version #=> String
resp.licenses[0].received_metadata.received_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "DISABLED", "WORKFLOW_COMPLETED"
resp.licenses[0].received_metadata.received_status_reason #=> String
resp.licenses[0].received_metadata.allowed_operations #=> Array
resp.licenses[0].received_metadata.allowed_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filters are supported:
    

      

    • 

      Beneficiary
      

      • 

    • 

      ProductSKU
      

      • 

    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


935

    		
    
      
# File 'sig/client.rbs', line 935

def list_received_licenses_for_organization: (


    		
  





    
      

  

  
    #list_resource_inventory(params = {})  ⇒ 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.resource_inventory_list[0].marketplace_product_codes #=> Array
resp.resource_inventory_list[0].marketplace_product_codes[0] #=> String
resp.resource_inventory_list[0].usage_operation #=> String
resp.resource_inventory_list[0].ami_id #=> String
resp.resource_inventory_list[0].host_id #=> String
resp.resource_inventory_list[0].region #=> String
resp.resource_inventory_list[0].instance_type #=> 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.
    
          
        
    • 
      
        
  • 
          :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 Amazon Web Services 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.
      

      • 

    • 

      tag:<key> - The key/value combination of a tag assigned to the
resource. Logical operators are EQUALS (single account) or
EQUALS | NOT_EQUALS (cross account).
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


953

    		
    
      
# File 'sig/client.rbs', line 953

def list_resource_inventory: (


    		
  





    
      

  

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

  

  




  

    
Lists the tags for the specified resource. For more information about
tagging support in License Manager, see the TagResource
operation.


  





  
  

    
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)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


971

    		
    
      
# File 'sig/client.rbs', line 971

def list_tags_for_resource: (


    		
  





    
      

  

  
    #list_tokens(params = {})  ⇒ Types::ListTokensResponse 
  

  

  




  

    
Lists your tokens.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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


    
      
        
Response structure

      
      

resp.tokens #=> Array
resp.tokens[0].token_id #=> String
resp.tokens[0].token_type #=> String
resp.tokens[0].license_arn #=> String
resp.tokens[0].expiration_time #=> String
resp.tokens[0].token_properties #=> Array
resp.tokens[0].token_properties[0] #=> String
resp.tokens[0].role_arns #=> Array
resp.tokens[0].role_arns[0] #=> String
resp.tokens[0].status #=> String
resp.next_token #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :token_ids
          (Array<String>)
          
            
          
          
            — 
    Token IDs.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Filters to scope the results. The following filter is supported:
    

      

    • LicenseArns
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Token for the next set of results.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Maximum number of results to return in a single call.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


982

    		
    
      
# File 'sig/client.rbs', line 982

def list_tokens: (


    		
  





    
      

  

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


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

      • 

    • 

      resourceType - The resource type (EC2_INSTANCE | EC2_HOST |
EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE).
      

      • 

    • 

      resourceAccount - The ID of the account that owns the resource.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1001

    		
    
      
# File 'sig/client.rbs', line 1001

def list_usage_for_license_configuration: (


    		
  





    
      

  

  
    #reject_grant(params = {})  ⇒ Types::RejectGrantResponse 
  

  

  




  

    
Rejects the specified grant.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.reject_grant({
  grant_arn: "Arn", # required
})


    
      
        
Response structure

      
      

resp.grant_arn #=> String
resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED", "WORKFLOW_COMPLETED"
resp.version #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :grant_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the grant.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1021

    		
    
      
# File 'sig/client.rbs', line 1021

def reject_grant: (


    		
  





    
      

  

  
    #tag_resource(params = {})  ⇒ Struct 
  

  

  




  

    
Adds the specified tags to the specified resource. The following
resources support tagging in License Manager:


    

  • 

    Licenses
    

    • 

  • 

    Grants
    

    • 

  • 

    License configurations
    

    • 

  • 

    Report generators
    

    • 



  





  
  

    
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)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the resource. The following examples
provide an example ARN for each supported resource in License Manager:
    

      

    • 

      Licenses -
arn:aws:license-manager::111122223333:license:l-EXAMPLE2da7646d6861033667f20e895
      

      • 

    • 

      Grants -
arn:aws:license-manager::111122223333:grant:g-EXAMPLE7b19f4a0ab73679b0beb52707
      

      • 

    • 

      License configurations -
arn:aws:license-manager:us-east-1:111122223333:license-configuration:lic-EXAMPLE6a788d4c8acd4264ff0ecf2ed2d
      

      • 

    • 

      Report generators -
arn:aws:license-manager:us-east-1:111122223333:report-generator:r-EXAMPLE825b4a4f8fe5a3e0c88824e5fc6
      

      • 

    
          
        
    • 
      
        
  • 
          :tags
          (required, Array<Types::Tag>)
          
            
          
          
            — 
    One or more tags.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1030

    		
    
      
# File 'sig/client.rbs', line 1030

def tag_resource: (


    		
  





    
      

  

  
    #untag_resource(params = {})  ⇒ Struct 
  

  

  




  

    
Removes the specified tags from the specified 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)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the resource.
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    Keys identifying the tags to remove.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1045

    		
    
      
# File 'sig/client.rbs', line 1045

def untag_resource: (


    		
  





    
      

  

  
    #update_license_asset_group(params = {})  ⇒ Types::UpdateLicenseAssetGroupResponse 
  

  

  




  

    
Updates a license asset group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_license_asset_group({
  name: "LicenseAssetResourceName",
  description: "LicenseAssetResourceDescription",
  license_asset_group_configurations: [
    {
      usage_dimension: "String",
    },
  ],
  associated_license_asset_ruleset_arns: ["Arn"], # required
  properties: [
    {
      key: "String", # required
      value: "String", # required
    },
  ],
  license_asset_group_arn: "Arn", # required
  status: "ACTIVE", # accepts ACTIVE, DISABLED, DELETED
  client_token: "String", # required
})


    
      
        
Response structure

      
      

resp.license_asset_group_arn #=> String
resp.status #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (String)
          
            
          
          
            — 
    License asset group name.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    License asset group description.
    
          
        
    • 
      
        
  • 
          :license_asset_group_configurations
          (Array<Types::LicenseAssetGroupConfiguration>)
          
            
          
          
            — 
    License asset group configurations.
    
          
        
    • 
      
        
  • 
          :associated_license_asset_ruleset_arns
          (required, Array<String>)
          
            
          
          
            — 
    ARNs of associated license asset rulesets.
    
          
        
    • 
      
        
  • 
          :properties
          (Array<Types::LicenseAssetGroupProperty>)
          
            
          
          
            — 
    License asset group properties.
    
          
        
    • 
      
        
  • 
          :license_asset_group_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset group.
    
          
        
    • 
      
        
  • 
          :status
          (String)
          
            
          
          
            — 
    License asset group status. The possible values are ACTIVE |
DISABLED.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1057

    		
    
      
# File 'sig/client.rbs', line 1057

def update_license_asset_group: (


    		
  





    
      

  

  
    #update_license_asset_ruleset(params = {})  ⇒ Types::UpdateLicenseAssetRulesetResponse 
  

  

  




  

    
Updates a license asset ruleset.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_license_asset_ruleset({
  name: "LicenseAssetResourceName",
  description: "LicenseAssetResourceDescription",
  rules: [ # required
    {
      rule_statement: { # required
        license_configuration_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
        },
        license_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
        },
        instance_rule_statement: {
          and_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          or_rule_statement: {
            matching_rule_statements: [
              {
                key_to_match: "String", # required
                constraint: "String", # required
                value_to_match: ["String"], # required
              },
            ],
            script_rule_statements: [
              {
                key_to_match: "String", # required
                script: "String", # required
              },
            ],
          },
          matching_rule_statement: {
            key_to_match: "String", # required
            constraint: "String", # required
            value_to_match: ["String"], # required
          },
          script_rule_statement: {
            key_to_match: "String", # required
            script: "String", # required
          },
        },
      },
    },
  ],
  license_asset_ruleset_arn: "Arn", # required
  client_token: "String", # required
})


    
      
        
Response structure

      
      

resp.license_asset_ruleset_arn #=> String


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :name
          (String)
          
            
          
          
            — 
    License asset ruleset name.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    License asset ruleset description.
    
          
        
    • 
      
        
  • 
          :rules
          (required, Array<Types::LicenseAssetRule>)
          
            
          
          
            — 
    License asset rules.
    
          
        
    • 
      
        
  • 
          :license_asset_ruleset_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the license asset ruleset.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1083

    		
    
      
# File 'sig/client.rbs', line 1083

def update_license_asset_ruleset: (


    		
  





    
      

  

  
    #update_license_configuration(params = {})  ⇒ 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"],
          product_information_filter_comparator: "String", # required
        },
      ],
    },
  ],
  disassociate_when_not_found: false,
  license_expiry: 1,
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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.
    
          
        
    • 
      
        
  • 
          :disassociate_when_not_found
          (Boolean)
          
            
          
          
            — 
    When true, disassociates a resource when software is uninstalled.
    
          
        
    • 
      
        
  • 
          :license_expiry
          (Integer)
          
            
          
          
            — 
    License configuration expiry time.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1098

    		
    
      
# File 'sig/client.rbs', line 1098

def update_license_configuration: (


    		
  





    
      

  

  
    #update_license_manager_report_generator(params = {})  ⇒ Struct 
  

  

  




  

    
Updates a report generator.


After you make changes to a report generator, it starts generating new
reports within 60 minutes of being updated.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_license_manager_report_generator({
  license_manager_report_generator_arn: "String", # required
  report_generator_name: "ReportGeneratorName", # required
  type: ["LicenseConfigurationSummaryReport"], # required, accepts LicenseConfigurationSummaryReport, LicenseConfigurationUsageReport, LicenseAssetGroupUsageReport
  report_context: { # required
    license_configuration_arns: ["Arn"],
    license_asset_group_arns: ["Arn"],
    report_start_date: Time.now,
    report_end_date: Time.now,
  },
  report_frequency: { # required
    value: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH, ONE_TIME
  },
  client_token: "ClientRequestToken", # required
  description: "String",
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :license_manager_report_generator_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the report generator to update.
    
          
        
    • 
      
        
  • 
          :report_generator_name
          (required, String)
          
            
          
          
            — 
    Name of the report generator.
    
          
        
    • 
      
        
  • 
          :type
          (required, Array<String>)
          
            
          
          
            — 
    Type of reports to generate. The following report types are supported:
    

      

    • 

      License configuration report - Reports the number and details of
consumed licenses for a license configuration.
      

      • 

    • 

      Resource report - Reports the tracked licenses and resource
consumption for a license configuration.
      

      • 

    
          
        
    • 
      
        
  • 
          :report_context
          (required, Types::ReportContext)
          
            
          
          
            — 
    The report context.
    
          
        
    • 
      
        
  • 
          :report_frequency
          (required, Types::ReportFrequency)
          
            
          
          
            — 
    Frequency by which reports are generated.
    
          
        
    • 
      
        
  • 
          :client_token
          (required, String)
          
            
          
          
            — 
    Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    Description of the report generator.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1118

    		
    
      
# File 'sig/client.rbs', line 1118

def update_license_manager_report_generator: (


    		
  





    
      

  

  
    #update_license_specifications_for_resource(params = {})  ⇒ Struct 
  

  

  




  

    
Adds or removes the specified license configurations for the specified
Amazon Web Services resource.


You can update the license specifications of AMIs, instances, and
hosts. You cannot update the license specifications for launch
templates and 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
      ami_association_scope: "String",
    },
  ],
  remove_license_specifications: [
    {
      license_configuration_arn: "String", # required
      ami_association_scope: "String",
    },
  ],
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_arn
          (required, String)
          
            
          
          
            — 
    Amazon Resource Name (ARN) of the Amazon Web Services 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:

  



  

    
      


1141

    		
    
      
# File 'sig/client.rbs', line 1141

def update_license_specifications_for_resource: (


    		
  





    
      

  

  
    #update_service_settings(params = {})  ⇒ 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,
  enabled_discovery_source_regions: ["String"],
})


    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :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 Organizations for cross-account discovery.
    
          
        
    • 
      
        
  • 
          :enable_cross_accounts_discovery
          (Boolean)
          
            
          
          
            — 
    Activates cross-account discovery.
    
          
        
    • 
      
        
  • 
          :enabled_discovery_source_regions
          (Array<String>)
          
            
          
          
            — 
    Cross region discovery enabled source regions.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1162

    		
    
      
# File 'sig/client.rbs', line 1162

def update_service_settings: (


    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  




  

    

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



Deprecated. 



  





  



  

    
      


4395
4396
4397

    		
    
      
# File 'lib/aws-sdk-licensemanager/client.rb', line 4395

def waiter_names
  []
end