Class: Aws::WorkLink::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb

Overview

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

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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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::WorkLink::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::WorkLink::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



385
386
387
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 385

def initialize(*args)
  super
end

Instance Method Details

#associate_domain(params = {}) ⇒ Struct

Specifies a domain to be associated to Amazon WorkLink.

Examples:

Request syntax with placeholder values


resp = client.associate_domain({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
  display_name: "DisplayName",
  acm_certificate_arn: "AcmCertificateArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

  • :domain_name (required, String) —

    The fully qualified domain name (FQDN).

  • :display_name (String) —

    The name to display.

  • :acm_certificate_arn (required, String) —

    The ARN of an issued ACM certificate that is valid for the domain being associated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



421
422
423
424
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 421

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

#associate_website_authorization_provider(params = {}) ⇒ Types::AssociateWebsiteAuthorizationProviderResponse

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

Examples:

Request syntax with placeholder values


resp = client.associate_website_authorization_provider({
  fleet_arn: "FleetArn", # required
  authorization_provider_type: "SAML", # required, accepts SAML
  domain_name: "DomainName",
})

Response structure


resp.authorization_provider_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :authorization_provider_type (required, String) —

    The authorization provider type.

  • :domain_name (String) —

    The domain name of the authorization provider. This applies only to SAML-based authorization providers.

Returns:

See Also:



460
461
462
463
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 460

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

#associate_website_certificate_authority(params = {}) ⇒ Types::AssociateWebsiteCertificateAuthorityResponse

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

Examples:

Request syntax with placeholder values


resp = client.associate_website_certificate_authority({
  fleet_arn: "FleetArn", # required
  certificate: "Certificate", # required
  display_name: "DisplayName",
})

Response structure


resp.website_ca_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :certificate (required, String) —

    The root certificate of the CA.

  • :display_name (String) —

    The certificate name to display.

Returns:

See Also:



498
499
500
501
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 498

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

#create_fleet(params = {}) ⇒ Types::CreateFleetResponse

Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  fleet_name: "FleetName", # required
  display_name: "DisplayName",
  optimize_for_end_user_location: false,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.fleet_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_name (required, String) —

    A unique name for the fleet.

  • :display_name (String) —

    The fleet name to display.

  • :optimize_for_end_user_location (Boolean) —

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

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

    The tags to add to the resource. A tag is a key-value pair.

Returns:

See Also:



544
545
546
547
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 544

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

#delete_fleet(params = {}) ⇒ Struct

Deletes a fleet. Prevents users from accessing previously associated websites.

Examples:

Request syntax with placeholder values


resp = client.delete_fleet({
  fleet_arn: "FleetArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



567
568
569
570
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 567

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

#describe_audit_stream_configuration(params = {}) ⇒ Types::DescribeAuditStreamConfigurationResponse

Describes the configuration for delivering audit streams to the customer account.

Examples:

Request syntax with placeholder values


resp = client.describe_audit_stream_configuration({
  fleet_arn: "FleetArn", # required
})

Response structure


resp.audit_stream_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:



596
597
598
599
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 596

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

#describe_company_network_configuration(params = {}) ⇒ Types::DescribeCompanyNetworkConfigurationResponse

Describes the networking configuration to access the internal websites associated with the specified fleet.

Examples:

Request syntax with placeholder values


resp = client.describe_company_network_configuration({
  fleet_arn: "FleetArn", # required
})

Response structure


resp.vpc_id #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:



631
632
633
634
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 631

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

#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse

Provides information about a user's device.

Examples:

Request syntax with placeholder values


resp = client.describe_device({
  fleet_arn: "FleetArn", # required
  device_id: "Id", # required
})

Response structure


resp.status #=> String, one of "ACTIVE", "SIGNED_OUT"
resp.model #=> String
resp.manufacturer #=> String
resp.operating_system #=> String
resp.operating_system_version #=> String
resp.patch_level #=> String
resp.first_accessed_time #=> Time
resp.last_accessed_time #=> Time
resp.username #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :device_id (required, String) —

    A unique identifier for a registered user's device.

Returns:

See Also:



679
680
681
682
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 679

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

#describe_device_policy_configuration(params = {}) ⇒ Types::DescribeDevicePolicyConfigurationResponse

Describes the device policy configuration for the specified fleet.

Examples:

Request syntax with placeholder values


resp = client.describe_device_policy_configuration({
  fleet_arn: "FleetArn", # required
})

Response structure


resp.device_ca_certificate #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:



707
708
709
710
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 707

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

#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse

Provides information about the domain.

Examples:

Request syntax with placeholder values


resp = client.describe_domain({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
})

Response structure


resp.domain_name #=> String
resp.display_name #=> String
resp.created_time #=> Time
resp.domain_status #=> String, one of "PENDING_VALIDATION", "ASSOCIATING", "ACTIVE", "INACTIVE", "DISASSOCIATING", "DISASSOCIATED", "FAILED_TO_ASSOCIATE", "FAILED_TO_DISASSOCIATE"
resp.acm_certificate_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

Returns:

See Also:



747
748
749
750
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 747

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

#describe_fleet_metadata(params = {}) ⇒ Types::DescribeFleetMetadataResponse

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_metadata({
  fleet_arn: "FleetArn", # required
})

Response structure


resp.created_time #=> Time
resp.last_updated_time #=> Time
resp.fleet_name #=> String
resp.display_name #=> String
resp.optimize_for_end_user_location #=> Boolean
resp.company_code #=> String
resp.fleet_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED_TO_CREATE", "FAILED_TO_DELETE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

See Also:



791
792
793
794
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 791

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

#describe_identity_provider_configuration(params = {}) ⇒ Types::DescribeIdentityProviderConfigurationResponse

Describes the identity provider configuration of the specified fleet.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_provider_configuration({
  fleet_arn: "FleetArn", # required
})

Response structure


resp.identity_provider_type #=> String, one of "SAML"
resp.service_provider_saml_metadata #=> String
resp.identity_provider_saml_metadata #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:



823
824
825
826
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 823

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

#describe_website_certificate_authority(params = {}) ⇒ Types::DescribeWebsiteCertificateAuthorityResponse

Provides information about the certificate authority.

Examples:

Request syntax with placeholder values


resp = client.describe_website_certificate_authority({
  fleet_arn: "FleetArn", # required
  website_ca_id: "Id", # required
})

Response structure


resp.certificate #=> String
resp.created_time #=> Time
resp.display_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :website_ca_id (required, String) —

    A unique identifier for the certificate authority.

Returns:

See Also:



859
860
861
862
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 859

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

#disassociate_domain(params = {}) ⇒ Struct

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

Examples:

Request syntax with placeholder values


resp = client.disassociate_domain({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 886

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

#disassociate_website_authorization_provider(params = {}) ⇒ Struct

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

Examples:

Request syntax with placeholder values


resp = client.disassociate_website_authorization_provider({
  fleet_arn: "FleetArn", # required
  authorization_provider_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :authorization_provider_id (required, String) —

    A unique identifier for the authorization provider.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



914
915
916
917
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 914

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

#disassociate_website_certificate_authority(params = {}) ⇒ Struct

Removes a certificate authority (CA).

Examples:

Request syntax with placeholder values


resp = client.disassociate_website_certificate_authority({
  fleet_arn: "FleetArn", # required
  website_ca_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :website_ca_id (required, String) —

    A unique identifier for the CA.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



940
941
942
943
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 940

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

#list_devices(params = {}) ⇒ Types::ListDevicesResponse

Retrieves a list of devices registered with the specified fleet.

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_devices({
  fleet_arn: "FleetArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.devices #=> Array
resp.devices[0].device_id #=> String
resp.devices[0].device_status #=> String, one of "ACTIVE", "SIGNED_OUT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



983
984
985
986
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 983

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

#list_domains(params = {}) ⇒ Types::ListDomainsResponse

Retrieves a list of domains associated to a specified fleet.

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_domains({
  fleet_arn: "FleetArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.domains #=> Array
resp.domains[0].domain_name #=> String
resp.domains[0].display_name #=> String
resp.domains[0].created_time #=> Time
resp.domains[0].domain_status #=> String, one of "PENDING_VALIDATION", "ASSOCIATING", "ACTIVE", "INACTIVE", "DISASSOCIATING", "DISASSOCIATED", "FAILED_TO_ASSOCIATE", "FAILED_TO_DISASSOCIATE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



1028
1029
1030
1031
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1028

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

#list_fleets(params = {}) ⇒ Types::ListFleetsResponse

Retrieves a list of fleets for the current account and Region.

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_fleets({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.fleet_summary_list #=> Array
resp.fleet_summary_list[0].fleet_arn #=> String
resp.fleet_summary_list[0].created_time #=> Time
resp.fleet_summary_list[0].last_updated_time #=> Time
resp.fleet_summary_list[0].fleet_name #=> String
resp.fleet_summary_list[0].display_name #=> String
resp.fleet_summary_list[0].company_code #=> String
resp.fleet_summary_list[0].fleet_status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED_TO_CREATE", "FAILED_TO_DELETE"
resp.fleet_summary_list[0].tags #=> Hash
resp.fleet_summary_list[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



1074
1075
1076
1077
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1074

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

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

Retrieves a list of tags for the specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

See Also:



1103
1104
1105
1106
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1103

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

#list_website_authorization_providers(params = {}) ⇒ Types::ListWebsiteAuthorizationProvidersResponse

Retrieves a list of website authorization providers associated with a specified fleet.

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_website_authorization_providers({
  fleet_arn: "FleetArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.website_authorization_providers #=> Array
resp.website_authorization_providers[0].authorization_provider_id #=> String
resp.website_authorization_providers[0].authorization_provider_type #=> String, one of "SAML"
resp.website_authorization_providers[0].domain_name #=> String
resp.website_authorization_providers[0].created_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :next_token (String) —

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



1149
1150
1151
1152
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1149

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

#list_website_certificate_authorities(params = {}) ⇒ Types::ListWebsiteCertificateAuthoritiesResponse

Retrieves a list of certificate authorities added for the current account and Region.

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_website_certificate_authorities({
  fleet_arn: "FleetArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.website_certificate_authorities #=> Array
resp.website_certificate_authorities[0].website_ca_id #=> String
resp.website_certificate_authorities[0].created_time #=> Time
resp.website_certificate_authorities[0].display_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

See Also:



1194
1195
1196
1197
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1194

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

#restore_domain_access(params = {}) ⇒ Struct

Moves a domain to ACTIVE status if it was in the INACTIVE status.

Examples:

Request syntax with placeholder values


resp = client.restore_domain_access({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1220
1221
1222
1223
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1220

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

#revoke_domain_access(params = {}) ⇒ Struct

Moves a domain to INACTIVE status if it was in the ACTIVE status.

Examples:

Request syntax with placeholder values


resp = client.revoke_domain_access({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1246
1247
1248
1249
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1246

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

#sign_out_user(params = {}) ⇒ Struct

Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

Examples:

Request syntax with placeholder values


resp = client.sign_out_user({
  fleet_arn: "FleetArn", # required
  username: "Username", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :username (required, String) —

    The name of the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1273
1274
1275
1276
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1273

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

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "FleetArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

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

    The tags to add to the resource. A tag is a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1304
1305
1306
1307
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1304

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

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

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1330
1331
1332
1333
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1330

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

#update_audit_stream_configuration(params = {}) ⇒ Struct

Updates the audit stream configuration for the fleet.

Examples:

Request syntax with placeholder values


resp = client.update_audit_stream_configuration({
  fleet_arn: "FleetArn", # required
  audit_stream_arn: "AuditStreamArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :audit_stream_arn (String) —

    The ARN of the Amazon Kinesis data stream that receives the audit events.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1357
1358
1359
1360
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1357

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

#update_company_network_configuration(params = {}) ⇒ Struct

Updates the company network configuration for the fleet.

Examples:

Request syntax with placeholder values


resp = client.update_company_network_configuration({
  fleet_arn: "FleetArn", # required
  vpc_id: "VpcId", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :vpc_id (required, String) —

    The VPC with connectivity to associated websites.

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

    The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

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

    The security groups associated with access to the provided subnets.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1392
1393
1394
1395
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1392

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

#update_device_policy_configuration(params = {}) ⇒ Struct

Updates the device policy configuration for the fleet.

Examples:

Request syntax with placeholder values


resp = client.update_device_policy_configuration({
  fleet_arn: "FleetArn", # required
  device_ca_certificate: "CertificateChain",
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :device_ca_certificate (String) —

    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1420
1421
1422
1423
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1420

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

#update_domain_metadata(params = {}) ⇒ Struct

Updates domain metadata, such as DisplayName.

Examples:

Request syntax with placeholder values


resp = client.update_domain_metadata({
  fleet_arn: "FleetArn", # required
  domain_name: "DomainName", # required
  display_name: "DisplayName",
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

  • :display_name (String) —

    The name to display.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1450
1451
1452
1453
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1450

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

#update_fleet_metadata(params = {}) ⇒ Struct

Updates fleet metadata, such as DisplayName.

Examples:

Request syntax with placeholder values


resp = client.update_fleet_metadata({
  fleet_arn: "FleetArn", # required
  display_name: "DisplayName",
  optimize_for_end_user_location: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :display_name (String) —

    The fleet name to display. The existing DisplayName is unset if null is passed.

  • :optimize_for_end_user_location (Boolean) —

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1483
1484
1485
1486
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1483

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

#update_identity_provider_configuration(params = {}) ⇒ Struct

Updates the identity provider configuration for the fleet.

Examples:

Request syntax with placeholder values


resp = client.update_identity_provider_configuration({
  fleet_arn: "FleetArn", # required
  identity_provider_type: "SAML", # required, accepts SAML
  identity_provider_saml_metadata: "SamlMetadata",
})

Parameters:

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

    ({})

Options Hash (params):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :identity_provider_type (required, String) —

    The type of identity provider.

  • :identity_provider_saml_metadata (String) —

    The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1515
1516
1517
1518
 
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1515

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