Class: Aws::LicenseManagerUserSubscriptions::Client

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

Overview

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

client = Aws::LicenseManagerUserSubscriptions::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

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

  • :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::LicenseManagerUserSubscriptions::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LicenseManagerUserSubscriptions::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 ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 471

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. 



1737
1738
1739
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1737

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. 



1740
1741
1742
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1740

def errors_module
  Errors
end

Instance Method Details

#associate_user(params = {}) ⇒ Types::AssociateUserResponse

Associates the user to an EC2 instance to utilize user-based subscriptions.

<note markdown=“1”> Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven’t closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see [Viewing your monthly charges] in the *Amazon Web Services Billing User Guide*.

</note>

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html

Examples:

Request syntax with placeholder values


resp = client.associate_user({
  username: "String", # required
  instance_id: "String", # required
  identity_provider: { # required
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  domain: "String",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.instance_user_summary.username #=> String
resp.instance_user_summary.instance_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.instance_user_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.instance_user_summary.status #=> String
resp.instance_user_summary.instance_user_arn #=> String
resp.instance_user_summary.status_message #=> String
resp.instance_user_summary.domain #=> String
resp.instance_user_summary.association_date #=> String
resp.instance_user_summary.disassociation_date #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :username (required, String) —

    The user name from the identity provider.

  • :instance_id (required, String) —

    The ID of the EC2 instance that provides the user-based subscription.

  • :identity_provider (required, Types::IdentityProvider) —

    The identity provider for the user.

  • :domain (String) —

    The domain name of the Active Directory that contains information for the user to associate.

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

    The tags that apply for the user association.

Returns:

See Also:



569
570
571
572
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 569

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

#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: {}) 


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1710

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::LicenseManagerUserSubscriptions')
  )
  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-licensemanagerusersubscriptions'
  context[:gem_version] = '1.51.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_license_server_endpoint(params = {}) ⇒ Types::CreateLicenseServerEndpointResponse

Creates a network endpoint for the Remote Desktop Services (RDS) license server.

Examples:

Request syntax with placeholder values


resp = client.create_license_server_endpoint({
  identity_provider_arn: "Arn", # required
  license_server_settings: { # required
    server_type: "RDS_SAL", # required, accepts RDS_SAL
    server_settings: { # required
      rds_sal_settings: {
        rds_sal_credentials_provider: { # required
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
      },
    },
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.identity_provider_arn #=> String
resp.license_server_endpoint_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the ‘IdentityProvider` resource that contains details about a registered identity provider. In the case of Active Directory, that can be a self-managed Active Directory or an Amazon Web Services Managed Active Directory that contains user identity details.

  • :license_server_settings (required, Types::LicenseServerSettings) —

    The ‘LicenseServerSettings` resource to create for the endpoint. The settings include the type of license server and the Secrets Manager secret that enables administrators to add or remove users associated with the license server.

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

    The tags that apply for the license server endpoint.

Returns:

See Also:



628
629
630
631
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 628

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

#delete_license_server_endpoint(params = {}) ⇒ Types::DeleteLicenseServerEndpointResponse

Deletes a ‘LicenseServerEndpoint` resource.

Examples:

Request syntax with placeholder values


resp = client.delete_license_server_endpoint({
  license_server_endpoint_arn: "Arn", # required
  server_type: "RDS_SAL", # required, accepts RDS_SAL
})

Response structure


resp.license_server_endpoint.identity_provider_arn #=> String
resp.license_server_endpoint.server_type #=> String, one of "RDS_SAL"
resp.license_server_endpoint.server_endpoint.endpoint #=> String
resp.license_server_endpoint.status_message #=> String
resp.license_server_endpoint.license_server_endpoint_id #=> String
resp.license_server_endpoint.license_server_endpoint_arn #=> String
resp.license_server_endpoint.license_server_endpoint_provisioning_status #=> String, one of "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DELETING", "DELETION_FAILED", "DELETED"
resp.license_server_endpoint.license_servers #=> Array
resp.license_server_endpoint.license_servers[0].provisioning_status #=> String, one of "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DELETING", "DELETION_FAILED", "DELETED"
resp.license_server_endpoint.license_servers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "NOT_APPLICABLE"
resp.license_server_endpoint.license_servers[0].ipv_4_address #=> String
resp.license_server_endpoint.license_servers[0].ipv_6_address #=> String
resp.license_server_endpoint.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :license_server_endpoint_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the ‘LicenseServerEndpoint` resource to delete.

  • :server_type (required, String) —

    The type of License Server that the delete request refers to.

Returns:

See Also:



673
674
675
676
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 673

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

#deregister_identity_provider(params = {}) ⇒ Types::DeregisterIdentityProviderResponse

Deregisters the Active Directory identity provider from License Manager user-based subscriptions.

Examples:

Request syntax with placeholder values


resp = client.deregister_identity_provider({
  identity_provider: {
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  product: "String",
  identity_provider_arn: "Arn",
})

Response structure


resp.identity_provider_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.identity_provider_summary.settings.subnets #=> Array
resp.identity_provider_summary.settings.subnets[0] #=> String
resp.identity_provider_summary.settings.security_group_id #=> String
resp.identity_provider_summary.product #=> String
resp.identity_provider_summary.status #=> String
resp.identity_provider_summary.identity_provider_arn #=> String
resp.identity_provider_summary.failure_message #=> String
resp.identity_provider_summary. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider (Types::IdentityProvider) —

    An object that specifies details for the Active Directory identity provider.

  • :product (String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :identity_provider_arn (String) —

    The Amazon Resource Name (ARN) that identifies the identity provider to deregister.

Returns:

See Also:



753
754
755
756
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 753

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

#disassociate_user(params = {}) ⇒ Types::DisassociateUserResponse

Disassociates the user from an EC2 instance providing user-based subscriptions.

Examples:

Request syntax with placeholder values


resp = client.disassociate_user({
  username: "String",
  instance_id: "String",
  identity_provider: {
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  instance_user_arn: "Arn",
  domain: "String",
})

Response structure


resp.instance_user_summary.username #=> String
resp.instance_user_summary.instance_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.instance_user_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.instance_user_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.instance_user_summary.status #=> String
resp.instance_user_summary.instance_user_arn #=> String
resp.instance_user_summary.status_message #=> String
resp.instance_user_summary.domain #=> String
resp.instance_user_summary.association_date #=> String
resp.instance_user_summary.disassociation_date #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :username (String) —

    The user name from the Active Directory identity provider for the user.

  • :instance_id (String) —

    The ID of the EC2 instance which provides user-based subscriptions.

  • :identity_provider (Types::IdentityProvider) —

    An object that specifies details for the Active Directory identity provider.

  • :instance_user_arn (String) —

    The Amazon Resource Name (ARN) of the user to disassociate from the EC2 instance.

  • :domain (String) —

    The domain name of the Active Directory that contains information for the user to disassociate.

Returns:

See Also:



839
840
841
842
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 839

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

#list_identity_providers(params = {}) ⇒ Types::ListIdentityProvidersResponse

Lists the Active Directory identity providers for user-based subscriptions.

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

Examples:

Request syntax with placeholder values


resp = client.list_identity_providers({
  max_results: 1,
  filters: [
    {
      attribute: "String",
      operation: "String",
      value: "String",
    },
  ],
  next_token: "String",
})

Response structure


resp.identity_provider_summaries #=> Array
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.identity_provider_summaries[0].settings.subnets #=> Array
resp.identity_provider_summaries[0].settings.subnets[0] #=> String
resp.identity_provider_summaries[0].settings.security_group_id #=> String
resp.identity_provider_summaries[0].product #=> String
resp.identity_provider_summaries[0].status #=> String
resp.identity_provider_summaries[0].identity_provider_arn #=> String
resp.identity_provider_summaries[0].failure_message #=> String
resp.identity_provider_summaries[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return from a single request.

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

    You can use the following filters to streamline results:

    • Product

    • DirectoryId

  • :next_token (String) —

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

Returns:

See Also:



910
911
912
913
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 910

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

#list_instances(params = {}) ⇒ Types::ListInstancesResponse

Lists the EC2 instances providing user-based subscriptions.

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

Examples:

Request syntax with placeholder values


resp = client.list_instances({
  max_results: 1,
  next_token: "String",
  filters: [
    {
      attribute: "String",
      operation: "String",
      value: "String",
    },
  ],
})

Response structure


resp.instance_summaries #=> Array
resp.instance_summaries[0].instance_id #=> String
resp.instance_summaries[0].status #=> String
resp.instance_summaries[0].products #=> Array
resp.instance_summaries[0].products[0] #=> String
resp.instance_summaries[0].last_status_check_date #=> String
resp.instance_summaries[0].status_message #=> String
resp.instance_summaries[0]. #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.instance_summaries[0].identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return from a single request.

  • :next_token (String) —

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

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

    You can use the following filters to streamline results:

    • Status

    • InstanceId

Returns:

See Also:



979
980
981
982
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 979

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

#list_license_server_endpoints(params = {}) ⇒ Types::ListLicenseServerEndpointsResponse

List the Remote Desktop Services (RDS) License Server endpoints

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

Examples:

Request syntax with placeholder values


resp = client.list_license_server_endpoints({
  max_results: 1,
  filters: [
    {
      attribute: "String",
      operation: "String",
      value: "String",
    },
  ],
  next_token: "String",
})

Response structure


resp.license_server_endpoints #=> Array
resp.license_server_endpoints[0].identity_provider_arn #=> String
resp.license_server_endpoints[0].server_type #=> String, one of "RDS_SAL"
resp.license_server_endpoints[0].server_endpoint.endpoint #=> String
resp.license_server_endpoints[0].status_message #=> String
resp.license_server_endpoints[0].license_server_endpoint_id #=> String
resp.license_server_endpoints[0].license_server_endpoint_arn #=> String
resp.license_server_endpoints[0].license_server_endpoint_provisioning_status #=> String, one of "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DELETING", "DELETION_FAILED", "DELETED"
resp.license_server_endpoints[0].license_servers #=> Array
resp.license_server_endpoints[0].license_servers[0].provisioning_status #=> String, one of "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DELETING", "DELETION_FAILED", "DELETED"
resp.license_server_endpoints[0].license_servers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "NOT_APPLICABLE"
resp.license_server_endpoints[0].license_servers[0].ipv_4_address #=> String
resp.license_server_endpoints[0].license_servers[0].ipv_6_address #=> String
resp.license_server_endpoints[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return from a single request.

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

    You can use the following filters to streamline results:

    • IdentityProviderArn

    ^

  • :next_token (String) —

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

Returns:

See Also:



1043
1044
1045
1046
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1043

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

#list_product_subscriptions(params = {}) ⇒ Types::ListProductSubscriptionsResponse

Lists the user-based subscription products available from an identity provider.

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

Examples:

Request syntax with placeholder values


resp = client.list_product_subscriptions({
  product: "String",
  identity_provider: { # required
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  max_results: 1,
  filters: [
    {
      attribute: "String",
      operation: "String",
      value: "String",
    },
  ],
  next_token: "String",
})

Response structure


resp.product_user_summaries #=> Array
resp.product_user_summaries[0].username #=> String
resp.product_user_summaries[0].product #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.product_user_summaries[0].status #=> String
resp.product_user_summaries[0].product_user_arn #=> String
resp.product_user_summaries[0].status_message #=> String
resp.product_user_summaries[0].domain #=> String
resp.product_user_summaries[0].subscription_start_date #=> String
resp.product_user_summaries[0].subscription_end_date #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :product (String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :identity_provider (required, Types::IdentityProvider) —

    An object that specifies details for the identity provider.

  • :max_results (Integer) —

    The maximum number of results to return from a single request.

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

    You can use the following filters to streamline results:

    • Status

    • Username

    • Domain

  • :next_token (String) —

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

Returns:

See Also:



1147
1148
1149
1150
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1147

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

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

Returns the list of tags for the specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Returns:

See Also:



1177
1178
1179
1180
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1177

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

#list_user_associations(params = {}) ⇒ Types::ListUserAssociationsResponse

Lists user associations for an identity provider.

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

Examples:

Request syntax with placeholder values


resp = client.list_user_associations({
  instance_id: "String", # required
  identity_provider: { # required
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  max_results: 1,
  filters: [
    {
      attribute: "String",
      operation: "String",
      value: "String",
    },
  ],
  next_token: "String",
})

Response structure


resp.instance_user_summaries #=> Array
resp.instance_user_summaries[0].username #=> String
resp.instance_user_summaries[0].instance_id #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.instance_user_summaries[0].status #=> String
resp.instance_user_summaries[0].instance_user_arn #=> String
resp.instance_user_summaries[0].status_message #=> String
resp.instance_user_summaries[0].domain #=> String
resp.instance_user_summaries[0].association_date #=> String
resp.instance_user_summaries[0].disassociation_date #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :instance_id (required, String) —

    The ID of the EC2 instance, which provides user-based subscriptions.

  • :identity_provider (required, Types::IdentityProvider) —

    An object that specifies details for the identity provider.

  • :max_results (Integer) —

    The maximum number of results to return from a single request.

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

    You can use the following filters to streamline results:

    • Status

    • Username

    • Domain

  • :next_token (String) —

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

Returns:

See Also:



1276
1277
1278
1279
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1276

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

#register_identity_provider(params = {}) ⇒ Types::RegisterIdentityProviderResponse

Registers an identity provider for user-based subscriptions.

Examples:

Request syntax with placeholder values


resp = client.register_identity_provider({
  identity_provider: { # required
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  product: "String", # required
  settings: {
    subnets: ["Subnet"], # required
    security_group_id: "SecurityGroup", # required
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.identity_provider_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.identity_provider_summary.settings.subnets #=> Array
resp.identity_provider_summary.settings.subnets[0] #=> String
resp.identity_provider_summary.settings.security_group_id #=> String
resp.identity_provider_summary.product #=> String
resp.identity_provider_summary.status #=> String
resp.identity_provider_summary.identity_provider_arn #=> String
resp.identity_provider_summary.failure_message #=> String
resp.identity_provider_summary. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider (required, Types::IdentityProvider) —

    An object that specifies details for the identity provider to register.

  • :product (required, String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :settings (Types::Settings) —

    The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

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

    The tags that apply to the identity provider’s registration.

Returns:

See Also:



1364
1365
1366
1367
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1364

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

#start_product_subscription(params = {}) ⇒ Types::StartProductSubscriptionResponse

Starts a product subscription for a user with the specified identity provider.

<note markdown=“1”> Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven’t closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see [Viewing your monthly charges] in the *Amazon Web Services Billing User Guide*.

</note>

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html

Examples:

Request syntax with placeholder values


resp = client.start_product_subscription({
  username: "String", # required
  identity_provider: { # required
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  product: "String", # required
  domain: "String",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.product_user_summary.username #=> String
resp.product_user_summary.product #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.product_user_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.product_user_summary.status #=> String
resp.product_user_summary.product_user_arn #=> String
resp.product_user_summary.status_message #=> String
resp.product_user_summary.domain #=> String
resp.product_user_summary.subscription_start_date #=> String
resp.product_user_summary.subscription_end_date #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :username (required, String) —

    The user name from the identity provider of the user.

  • :identity_provider (required, Types::IdentityProvider) —

    An object that specifies details for the identity provider.

  • :product (required, String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :domain (String) —

    The domain name of the Active Directory that contains the user for whom to start the product subscription.

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

    The tags that apply to the product subscription.

Returns:

See Also:



1465
1466
1467
1468
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1465

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

#stop_product_subscription(params = {}) ⇒ Types::StopProductSubscriptionResponse

Stops a product subscription for a user with the specified identity provider.

Examples:

Request syntax with placeholder values


resp = client.stop_product_subscription({
  username: "String",
  identity_provider: {
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  product: "String",
  product_user_arn: "Arn",
  domain: "String",
})

Response structure


resp.product_user_summary.username #=> String
resp.product_user_summary.product #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.product_user_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.product_user_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.product_user_summary.status #=> String
resp.product_user_summary.product_user_arn #=> String
resp.product_user_summary.status_message #=> String
resp.product_user_summary.domain #=> String
resp.product_user_summary.subscription_start_date #=> String
resp.product_user_summary.subscription_end_date #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :username (String) —

    The user name from the identity provider for the user.

  • :identity_provider (Types::IdentityProvider) —

    An object that specifies details for the identity provider.

  • :product (String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :product_user_arn (String) —

    The Amazon Resource Name (ARN) of the product user.

  • :domain (String) —

    The domain name of the Active Directory that contains the user for whom to stop the product subscription.

Returns:

See Also:



1552
1553
1554
1555
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1552

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to tag.

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

    The tags to apply to the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1580
1581
1582
1583
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1580

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

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

    The tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1607
1608
1609
1610
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1607

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

#update_identity_provider_settings(params = {}) ⇒ Types::UpdateIdentityProviderSettingsResponse

Updates additional product configuration settings for the registered identity provider.

Examples:

Request syntax with placeholder values


resp = client.update_identity_provider_settings({
  identity_provider: {
    active_directory_identity_provider: {
      directory_id: "Directory",
      active_directory_settings: {
        domain_name: "String",
        domain_ipv_4_list: ["IpV4"],
        domain_ipv_6_list: ["IpV6"],
        domain_credentials_provider: {
          secrets_manager_credentials_provider: {
            secret_id: "SecretsManagerCredentialsProviderSecretIdString",
          },
        },
        domain_network_settings: {
          subnets: ["Subnet"], # required
        },
      },
      active_directory_type: "SELF_MANAGED", # accepts SELF_MANAGED, AWS_MANAGED
      is_shared_active_directory: false,
    },
  },
  product: "String",
  identity_provider_arn: "Arn",
  update_settings: { # required
    add_subnets: ["Subnet"], # required
    remove_subnets: ["Subnet"], # required
    security_group_id: "SecurityGroup",
  },
})

Response structure


resp.identity_provider_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_name #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_4_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_ipv_6_list[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_credentials_provider.secrets_manager_credentials_provider.secret_id #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets #=> Array
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_settings.domain_network_settings.subnets[0] #=> String
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.active_directory_type #=> String, one of "SELF_MANAGED", "AWS_MANAGED"
resp.identity_provider_summary.identity_provider.active_directory_identity_provider.is_shared_active_directory #=> Boolean
resp.identity_provider_summary.settings.subnets #=> Array
resp.identity_provider_summary.settings.subnets[0] #=> String
resp.identity_provider_summary.settings.security_group_id #=> String
resp.identity_provider_summary.product #=> String
resp.identity_provider_summary.status #=> String
resp.identity_provider_summary.identity_provider_arn #=> String
resp.identity_provider_summary.failure_message #=> String
resp.identity_provider_summary. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider (Types::IdentityProvider) —

    Refers to an identity provider.

  • :product (String) —

    The name of the user-based subscription product.

    Valid values: ‘VISUAL_STUDIO_ENTERPRISE` | `VISUAL_STUDIO_PROFESSIONAL` | `OFFICE_PROFESSIONAL_PLUS` | `REMOTE_DESKTOP_SERVICES`

  • :identity_provider_arn (String) —

    The Amazon Resource Name (ARN) of the identity provider to update.

  • :update_settings (required, Types::UpdateSettings) —

    Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:

    • Subnets which you want to add to provision VPC endpoints.

    • Subnets which you want to remove the VPC endpoints from.

    • Security group ID which permits traffic to the VPC endpoints.

Returns:

See Also:



1701
1702
1703
1704
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1701

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

#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. 


1730
1731
1732
 
# File 'lib/aws-sdk-licensemanagerusersubscriptions/client.rb', line 1730

def waiter_names
  []
end