You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkLink::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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

worklink = Aws::WorkLink::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::WorkLink::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::WorkLink::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_domain(options = {}) ⇒ 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
})

Options Hash (options):

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

#associate_website_authorization_provider(options = {}) ⇒ 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

Options Hash (options):

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

#associate_website_certificate_authority(options = {}) ⇒ 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

Options Hash (options):

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

#create_fleet(options = {}) ⇒ 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

Options Hash (options):

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

#delete_fleet(options = {}) ⇒ 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
})

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#describe_audit_stream_configuration(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:

#describe_company_network_configuration(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:

#describe_device(options = {}) ⇒ 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

Options Hash (options):

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

#describe_device_policy_configuration(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:

#describe_domain(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :domain_name (required, String) —

    The name of the domain.

Returns:

See Also:

#describe_fleet_metadata(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :fleet_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

See Also:

#describe_identity_provider_configuration(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

Returns:

See Also:

#describe_website_certificate_authority(options = {}) ⇒ 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

Options Hash (options):

  • :fleet_arn (required, String) —

    The ARN of the fleet.

  • :website_ca_id (required, String) —

    A unique identifier for the certificate authority.

Returns:

See Also:

#disassociate_domain(options = {}) ⇒ 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
})

Options Hash (options):

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

#disassociate_website_authorization_provider(options = {}) ⇒ 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
})

Options Hash (options):

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

#disassociate_website_certificate_authority(options = {}) ⇒ 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
})

Options Hash (options):

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

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

Retrieves a list of devices registered with the specified fleet.

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

Options Hash (options):

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

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

Retrieves a list of domains associated to a specified fleet.

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

Options Hash (options):

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

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

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

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

Options Hash (options):

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

#list_tags_for_resource(options = {}) ⇒ 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

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the fleet.

Returns:

See Also:

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

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

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

Options Hash (options):

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

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

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

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

Options Hash (options):

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

#restore_domain_access(options = {}) ⇒ 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
})

Options Hash (options):

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

#revoke_domain_access(options = {}) ⇒ 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
})

Options Hash (options):

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

#sign_out_user(options = {}) ⇒ 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
})

Options Hash (options):

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

#tag_resource(options = {}) ⇒ 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",
  },
})

Options Hash (options):

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

#untag_resource(options = {}) ⇒ 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
})

Options Hash (options):

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

#update_audit_stream_configuration(options = {}) ⇒ 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",
})

Options Hash (options):

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

#update_company_network_configuration(options = {}) ⇒ 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
})

Options Hash (options):

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

#update_device_policy_configuration(options = {}) ⇒ 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",
})

Options Hash (options):

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

#update_domain_metadata(options = {}) ⇒ 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",
})

Options Hash (options):

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

#update_fleet_metadata(options = {}) ⇒ 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,
})

Options Hash (options):

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

#update_identity_provider_configuration(options = {}) ⇒ 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",
})

Options Hash (options):

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

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Aws::Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.