Class: Aws::LicenseManager::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LicenseManager::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb
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.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_grant(params = {}) ⇒ Types::AcceptGrantResponse
Accepts the specified grant.
-
#check_in_license(params = {}) ⇒ Struct
Checks in the specified license.
-
#checkout_borrow_license(params = {}) ⇒ Types::CheckoutBorrowLicenseResponse
Checks out the specified license for offline use.
-
#checkout_license(params = {}) ⇒ Types::CheckoutLicenseResponse
Checks out the specified license.
-
#create_grant(params = {}) ⇒ Types::CreateGrantResponse
Creates a grant for the specified license.
-
#create_grant_version(params = {}) ⇒ Types::CreateGrantVersionResponse
Creates a new version of the specified grant.
-
#create_license(params = {}) ⇒ Types::CreateLicenseResponse
Creates a license.
-
#create_license_configuration(params = {}) ⇒ Types::CreateLicenseConfigurationResponse
Creates a license configuration.
-
#create_license_version(params = {}) ⇒ Types::CreateLicenseVersionResponse
Creates a new version of the specified license.
-
#create_token(params = {}) ⇒ Types::CreateTokenResponse
Creates a long-lived token.
-
#delete_grant(params = {}) ⇒ Types::DeleteGrantResponse
Deletes the specified grant.
-
#delete_license(params = {}) ⇒ Types::DeleteLicenseResponse
Deletes the specified license.
-
#delete_license_configuration(params = {}) ⇒ Struct
Deletes the specified license configuration.
-
#delete_token(params = {}) ⇒ Struct
Deletes the specified token.
-
#extend_license_consumption(params = {}) ⇒ Types::ExtendLicenseConsumptionResponse
Extends the expiration date for license consumption.
-
#get_access_token(params = {}) ⇒ Types::GetAccessTokenResponse
Gets a temporary access token to use with AssumeRoleWithWebIdentity.
-
#get_grant(params = {}) ⇒ Types::GetGrantResponse
Gets detailed information about the specified grant.
-
#get_license(params = {}) ⇒ Types::GetLicenseResponse
Gets detailed information about the specified license.
-
#get_license_configuration(params = {}) ⇒ Types::GetLicenseConfigurationResponse
Gets detailed information about the specified license configuration.
-
#get_license_usage(params = {}) ⇒ Types::GetLicenseUsageResponse
Gets detailed information about the usage of the specified license.
-
#get_service_settings(params = {}) ⇒ Types::GetServiceSettingsResponse
Gets the License Manager settings for the current Region.
-
#list_associations_for_license_configuration(params = {}) ⇒ Types::ListAssociationsForLicenseConfigurationResponse
Lists the resource associations for the specified license configuration.
-
#list_distributed_grants(params = {}) ⇒ Types::ListDistributedGrantsResponse
Lists the grants distributed for the specified license.
-
#list_failures_for_license_configuration_operations(params = {}) ⇒ Types::ListFailuresForLicenseConfigurationOperationsResponse
Lists the license configuration operations that failed.
-
#list_license_configurations(params = {}) ⇒ Types::ListLicenseConfigurationsResponse
Lists the license configurations for your account.
-
#list_license_specifications_for_resource(params = {}) ⇒ Types::ListLicenseSpecificationsForResourceResponse
Describes the license configurations for the specified resource.
-
#list_license_versions(params = {}) ⇒ Types::ListLicenseVersionsResponse
Lists all versions of the specified license.
-
#list_licenses(params = {}) ⇒ Types::ListLicensesResponse
Lists the licenses for your account.
-
#list_received_grants(params = {}) ⇒ Types::ListReceivedGrantsResponse
Lists grants that are received but not accepted.
-
#list_received_licenses(params = {}) ⇒ Types::ListReceivedLicensesResponse
Lists received licenses.
-
#list_resource_inventory(params = {}) ⇒ Types::ListResourceInventoryResponse
Lists resources managed using Systems Manager inventory.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified license configuration.
-
#list_tokens(params = {}) ⇒ Types::ListTokensResponse
Lists your 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.
-
#reject_grant(params = {}) ⇒ Types::RejectGrantResponse
Rejects the specified grant.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified license configuration.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified license configuration.
-
#update_license_configuration(params = {}) ⇒ Struct
Modifies the attributes of an existing license configuration.
-
#update_license_specifications_for_resource(params = {}) ⇒ Struct
Adds or removes the specified license configurations for the specified AWS resource.
-
#update_service_settings(params = {}) ⇒ Struct
Updates License Manager settings for the current Region.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#accept_grant(params = {}) ⇒ Types::AcceptGrantResponse
Accepts the specified grant.
367 368 369 370 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 367 def accept_grant(params = {}, = {}) req = build_request(:accept_grant, params) req.send_request() end |
#check_in_license(params = {}) ⇒ Struct
Checks in the specified license. Check in a license when it is no longer in use.
394 395 396 397 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 394 def check_in_license(params = {}, = {}) req = build_request(:check_in_license, params) req.send_request() end |
#checkout_borrow_license(params = {}) ⇒ Types::CheckoutBorrowLicenseResponse
Checks out the specified license for offline use.
480 481 482 483 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 480 def checkout_borrow_license(params = {}, = {}) req = build_request(:checkout_borrow_license, params) req.send_request() end |
#checkout_license(params = {}) ⇒ Types::CheckoutLicenseResponse
Checks out the specified license.
554 555 556 557 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 554 def checkout_license(params = {}, = {}) req = build_request(:checkout_license, params) req.send_request() end |
#create_grant(params = {}) ⇒ Types::CreateGrantResponse
Creates a grant for the specified license. A grant shares the use of license entitlements with specific AWS accounts.
608 609 610 611 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 608 def create_grant(params = {}, = {}) req = build_request(:create_grant, params) req.send_request() end |
#create_grant_version(params = {}) ⇒ Types::CreateGrantVersionResponse
Creates a new version of the specified grant.
661 662 663 664 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 661 def create_grant_version(params = {}, = {}) req = build_request(:create_grant_version, params) req.send_request() end |
#create_license(params = {}) ⇒ Types::CreateLicenseResponse
Creates a license.
766 767 768 769 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 766 def create_license(params = {}, = {}) req = build_request(:create_license, params) req.send_request() end |
#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.
871 872 873 874 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 871 def create_license_configuration(params = {}, = {}) req = build_request(:create_license_configuration, params) req.send_request() end |
#create_license_version(params = {}) ⇒ Types::CreateLicenseVersionResponse
Creates a new version of the specified license.
980 981 982 983 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 980 def create_license_version(params = {}, = {}) req = build_request(:create_license_version, params) req.send_request() end |
#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.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1037 def create_token(params = {}, = {}) req = build_request(:create_token, params) req.send_request() end |
#delete_grant(params = {}) ⇒ Types::DeleteGrantResponse
Deletes the specified grant.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1073 def delete_grant(params = {}, = {}) req = build_request(:delete_grant, params) req.send_request() end |
#delete_license(params = {}) ⇒ Types::DeleteLicenseResponse
Deletes the specified license.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1107 def delete_license(params = {}, = {}) req = build_request(:delete_license, params) req.send_request() end |
#delete_license_configuration(params = {}) ⇒ Struct
Deletes the specified license configuration.
You cannot delete a license configuration that is in use.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1131 def delete_license_configuration(params = {}, = {}) req = build_request(:delete_license_configuration, params) req.send_request() end |
#delete_token(params = {}) ⇒ Struct
Deletes the specified token. Must be called in the license home Region.
1154 1155 1156 1157 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1154 def delete_token(params = {}, = {}) req = build_request(:delete_token, params) req.send_request() end |
#extend_license_consumption(params = {}) ⇒ Types::ExtendLicenseConsumptionResponse
Extends the expiration date for license consumption.
1190 1191 1192 1193 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1190 def extend_license_consumption(params = {}, = {}) req = build_request(:extend_license_consumption, params) req.send_request() end |
#get_access_token(params = {}) ⇒ Types::GetAccessTokenResponse
Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1223 def get_access_token(params = {}, = {}) req = build_request(:get_access_token, params) req.send_request() end |
#get_grant(params = {}) ⇒ Types::GetGrantResponse
Gets detailed information about the specified grant.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1265 def get_grant(params = {}, = {}) req = build_request(:get_grant, params) req.send_request() end |
#get_license(params = {}) ⇒ Types::GetLicenseResponse
Gets detailed information about the specified license.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1324 def get_license(params = {}, = {}) req = build_request(:get_license, params) req.send_request() end |
#get_license_configuration(params = {}) ⇒ Types::GetLicenseConfigurationResponse
Gets detailed information about the specified license configuration.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1397 def get_license_configuration(params = {}, = {}) req = build_request(:get_license_configuration, params) req.send_request() end |
#get_license_usage(params = {}) ⇒ Types::GetLicenseUsageResponse
Gets detailed information about the usage of the specified license.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1429 def get_license_usage(params = {}, = {}) req = build_request(:get_license_usage, params) req.send_request() end |
#get_service_settings(params = {}) ⇒ Types::GetServiceSettingsResponse
Gets the License Manager settings for the current Region.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1456 def get_service_settings(params = {}, = {}) req = build_request(:get_service_settings, params) req.send_request() end |
#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).
1504 1505 1506 1507 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1504 def list_associations_for_license_configuration(params = {}, = {}) req = build_request(:list_associations_for_license_configuration, params) req.send_request() end |
#list_distributed_grants(params = {}) ⇒ Types::ListDistributedGrantsResponse
Lists the grants distributed for the specified license.
1570 1571 1572 1573 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1570 def list_distributed_grants(params = {}, = {}) req = build_request(:list_distributed_grants, params) req.send_request() end |
#list_failures_for_license_configuration_operations(params = {}) ⇒ Types::ListFailuresForLicenseConfigurationOperationsResponse
Lists the license configuration operations that failed.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1618 def list_failures_for_license_configuration_operations(params = {}, = {}) req = build_request(:list_failures_for_license_configuration_operations, params) req.send_request() end |
#list_license_configurations(params = {}) ⇒ Types::ListLicenseConfigurationsResponse
Lists the license configurations for your account.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1705 def list_license_configurations(params = {}, = {}) req = build_request(:list_license_configurations, params) req.send_request() end |
#list_license_specifications_for_resource(params = {}) ⇒ Types::ListLicenseSpecificationsForResourceResponse
Describes the license configurations for the specified resource.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1746 def list_license_specifications_for_resource(params = {}, = {}) req = build_request(:list_license_specifications_for_resource, params) req.send_request() end |
#list_license_versions(params = {}) ⇒ Types::ListLicenseVersionsResponse
Lists all versions of the specified license.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1812 def list_license_versions(params = {}, = {}) req = build_request(:list_license_versions, params) req.send_request() end |
#list_licenses(params = {}) ⇒ Types::ListLicensesResponse
Lists the licenses for your account.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1895 def list_licenses(params = {}, = {}) req = build_request(:list_licenses, params) req.send_request() end |
#list_received_grants(params = {}) ⇒ Types::ListReceivedGrantsResponse
Lists grants that are received but not accepted.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 1957 def list_received_grants(params = {}, = {}) req = build_request(:list_received_grants, params) req.send_request() end |
#list_received_licenses(params = {}) ⇒ Types::ListReceivedLicensesResponse
Lists received licenses.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2043 def list_received_licenses(params = {}, = {}) req = build_request(:list_received_licenses, params) req.send_request() end |
#list_resource_inventory(params = {}) ⇒ Types::ListResourceInventoryResponse
Lists resources managed using Systems Manager inventory.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2115 def list_resource_inventory(params = {}, = {}) req = build_request(:list_resource_inventory, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified license configuration.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2145 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tokens(params = {}) ⇒ Types::ListTokensResponse
Lists your tokens.
2205 2206 2207 2208 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2205 def list_tokens(params = {}, = {}) req = build_request(:list_tokens, params) req.send_request() end |
#list_usage_for_license_configuration(params = {}) ⇒ Types::ListUsageForLicenseConfigurationResponse
Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2272 def list_usage_for_license_configuration(params = {}, = {}) req = build_request(:list_usage_for_license_configuration, params) req.send_request() end |
#reject_grant(params = {}) ⇒ Types::RejectGrantResponse
Rejects the specified grant.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2304 def reject_grant(params = {}, = {}) req = build_request(:reject_grant, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified license configuration.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2335 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified license configuration.
2361 2362 2363 2364 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2361 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_license_configuration(params = {}) ⇒ Struct
Modifies the attributes of an existing license configuration.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2427 def update_license_configuration(params = {}, = {}) req = build_request(:update_license_configuration, params) req.send_request() end |
#update_license_specifications_for_resource(params = {}) ⇒ Struct
Adds or removes the specified license configurations for the specified AWS resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.
2473 2474 2475 2476 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2473 def update_license_specifications_for_resource(params = {}, = {}) req = build_request(:update_license_specifications_for_resource, params) req.send_request() end |
#update_service_settings(params = {}) ⇒ Struct
Updates License Manager settings for the current Region.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-licensemanager/lib/aws-sdk-licensemanager/client.rb', line 2512 def update_service_settings(params = {}, = {}) req = build_request(:update_service_settings, params) req.send_request() end |