AWS License Manager¶

Description¶

License Manager makes it easier to manage licenses from software vendors across multiple Amazon Web Services accounts and on-premises servers.

Usage¶

licensemanager(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- licensemanager(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`accept_grant`	Accepts the specified grant
`check_in_license`	Checks in the specified license
`checkout_borrow_license`	Checks out the specified license for offline use
`checkout_license`	Checks out the specified license
`create_grant`	Creates a grant for the specified license
`create_grant_version`	Creates a new version of the specified grant
`create_license`	Creates a license
`create_license_asset_group`	Creates a license asset group
`create_license_asset_ruleset`	Creates a license asset ruleset
`create_license_configuration`	Creates a license configuration
`create_license_conversion_task_for_resource`	Creates a new license conversion task
`create_license_manager_report_generator`	Creates a report generator
`create_license_version`	Creates a new version of the specified license
`create_token`	Creates a long-lived token
`delete_grant`	Deletes the specified grant
`delete_license`	Deletes the specified license
`delete_license_asset_group`	Deletes a license asset group
`delete_license_asset_ruleset`	Deletes a license asset ruleset
`delete_license_configuration`	Deletes the specified license configuration
`delete_license_manager_report_generator`	Deletes the specified report generator
`delete_token`	Deletes the specified token
`extend_license_consumption`	Extends the expiration date for license consumption
`get_access_token`	Gets a temporary access token to use with AssumeRoleWithWebIdentity
`get_grant`	Gets detailed information about the specified grant
`get_license`	Gets detailed information about the specified license
`get_license_asset_group`	Gets a license asset group
`get_license_asset_ruleset`	Gets a license asset ruleset
`get_license_configuration`	Gets detailed information about the specified license configuration
`get_license_conversion_task`	Gets information about the specified license type conversion task
`get_license_manager_report_generator`	Gets information about the specified report generator
`get_license_usage`	Gets detailed information about the usage of the specified license
`get_service_settings`	Gets the License Manager settings for the current Region
`list_assets_for_license_asset_group`	Lists assets for a license asset group
`list_associations_for_license_configuration`	Lists the resource associations for the specified license configuration
`list_distributed_grants`	Lists the grants distributed for the specified license
`list_failures_for_license_configuration_operations`	Lists the license configuration operations that failed
`list_license_asset_groups`	Lists license asset groups
`list_license_asset_rulesets`	Lists license asset rulesets
`list_license_configurations`	Lists the license configurations for your account
`list_license_configurations_for_organization`	Lists license configurations for an organization
`list_license_conversion_tasks`	Lists the license type conversion tasks for your account
`list_license_manager_report_generators`	Lists the report generators for your account
`list_licenses`	Lists the licenses for your account
`list_license_specifications_for_resource`	Describes the license configurations for the specified resource
`list_license_versions`	Lists all versions of the specified license
`list_received_grants`	Lists grants that are received
`list_received_grants_for_organization`	Lists the grants received for all accounts in the organization
`list_received_licenses`	Lists received licenses
`list_received_licenses_for_organization`	Lists the licenses received for all accounts in the organization
`list_resource_inventory`	Lists resources managed using Systems Manager inventory
`list_tags_for_resource`	Lists the tags for the specified resource
`list_tokens`	Lists your tokens
`list_usage_for_license_configuration`	Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time
`reject_grant`	Rejects the specified grant
`tag_resource`	Adds the specified tags to the specified resource
`untag_resource`	Removes the specified tags from the specified resource
`update_license_asset_group`	Updates a license asset group
`update_license_asset_ruleset`	Updates a license asset ruleset
`update_license_configuration`	Modifies the attributes of an existing license configuration
`update_license_manager_report_generator`	Updates a report generator
`update_license_specifications_for_resource`	Adds or removes the specified license configurations for the specified Amazon Web Services resource
`update_service_settings`	Updates License Manager settings for the current Region

Examples¶

svc <- licensemanager()
svc$accept_grant(
  Foo = 123
)