Skip to content

AWS License Manager User Subscriptions

Description

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Usage

licensemanagerusersubscriptions(
  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 <- licensemanagerusersubscriptions(
  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

associate_user Associates the user to an EC2 instance to utilize user-based subscriptions
create_license_server_endpoint Creates a network endpoint for the Remote Desktop Services (RDS) license server
delete_license_server_endpoint Deletes a LicenseServerEndpoint resource
deregister_identity_provider Deregisters the Active Directory identity provider from License Manager user-based subscriptions
disassociate_user Disassociates the user from an EC2 instance providing user-based subscriptions
list_identity_providers Lists the Active Directory identity providers for user-based subscriptions
list_instances Lists the EC2 instances providing user-based subscriptions
list_license_server_endpoints List the Remote Desktop Services (RDS) License Server endpoints
list_product_subscriptions Lists the user-based subscription products available from an identity provider
list_tags_for_resource Returns the list of tags for the specified resource
list_user_associations Lists user associations for an identity provider
register_identity_provider Registers an identity provider for user-based subscriptions
start_product_subscription Starts a product subscription for a user with the specified identity provider
stop_product_subscription Stops a product subscription for a user with the specified identity provider
tag_resource Adds tags to a resource
untag_resource Removes tags from a resource
update_identity_provider_settings Updates additional product configuration settings for the registered identity provider

Examples

svc <- licensemanagerusersubscriptions()
svc$associate_user(
  Foo = 123
)