Class: Aws::WorkLink::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkLink::Client
- 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
API Operations collapse
-
#associate_domain(params = {}) ⇒ Struct
Specifies a domain to be associated to Amazon WorkLink.
-
#associate_website_authorization_provider(params = {}) ⇒ Types::AssociateWebsiteAuthorizationProviderResponse
Associates a website authorization provider with a specified fleet.
-
#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.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResponse
Creates a fleet.
-
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet.
-
#describe_audit_stream_configuration(params = {}) ⇒ Types::DescribeAuditStreamConfigurationResponse
Describes the configuration for delivering audit streams to the customer account.
-
#describe_company_network_configuration(params = {}) ⇒ Types::DescribeCompanyNetworkConfigurationResponse
Describes the networking configuration to access the internal websites associated with the specified fleet.
-
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Provides information about a user's device.
-
#describe_device_policy_configuration(params = {}) ⇒ Types::DescribeDevicePolicyConfigurationResponse
Describes the device policy configuration for the specified fleet.
-
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Provides information about the domain.
-
#describe_fleet_metadata(params = {}) ⇒ Types::DescribeFleetMetadataResponse
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
-
#describe_identity_provider_configuration(params = {}) ⇒ Types::DescribeIdentityProviderConfigurationResponse
Describes the identity provider configuration of the specified fleet.
-
#describe_website_certificate_authority(params = {}) ⇒ Types::DescribeWebsiteCertificateAuthorityResponse
Provides information about the certificate authority.
-
#disassociate_domain(params = {}) ⇒ Struct
Disassociates a domain from Amazon WorkLink.
-
#disassociate_website_authorization_provider(params = {}) ⇒ Struct
Disassociates a website authorization provider from a specified fleet.
-
#disassociate_website_certificate_authority(params = {}) ⇒ Struct
Removes a certificate authority (CA).
-
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
Retrieves a list of devices registered with the specified fleet.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Retrieves a list of domains associated to a specified fleet.
-
#list_fleets(params = {}) ⇒ Types::ListFleetsResponse
Retrieves a list of fleets for the current account and Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for the specified resource.
-
#list_website_authorization_providers(params = {}) ⇒ Types::ListWebsiteAuthorizationProvidersResponse
Retrieves a list of website authorization providers associated with a specified fleet.
-
#list_website_certificate_authorities(params = {}) ⇒ Types::ListWebsiteCertificateAuthoritiesResponse
Retrieves a list of certificate authorities added for the current account and Region.
-
#restore_domain_access(params = {}) ⇒ Struct
Moves a domain to ACTIVE status if it was in the INACTIVE status.
-
#revoke_domain_access(params = {}) ⇒ Struct
Moves a domain to INACTIVE status if it was in the ACTIVE status.
-
#sign_out_user(params = {}) ⇒ Struct
Signs the user out from all of their devices.
-
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified resource, such as a fleet.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_audit_stream_configuration(params = {}) ⇒ Struct
Updates the audit stream configuration for the fleet.
-
#update_company_network_configuration(params = {}) ⇒ Struct
Updates the company network configuration for the fleet.
-
#update_device_policy_configuration(params = {}) ⇒ Struct
Updates the device policy configuration for the fleet.
-
#update_domain_metadata(params = {}) ⇒ Struct
Updates domain metadata, such as DisplayName.
-
#update_fleet_metadata(params = {}) ⇒ Struct
Updates fleet metadata, such as DisplayName.
-
#update_identity_provider_configuration(params = {}) ⇒ Struct
Updates the identity provider configuration for the fleet.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
410 411 412 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#associate_domain(params = {}) ⇒ Struct
Specifies a domain to be associated to Amazon WorkLink.
446 447 448 449 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 446 def associate_domain(params = {}, = {}) req = build_request(:associate_domain, params) req.send_request() 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.
485 486 487 488 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 485 def (params = {}, = {}) req = build_request(:associate_website_authorization_provider, params) req.send_request() 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.
523 524 525 526 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 523 def (params = {}, = {}) req = build_request(:associate_website_certificate_authority, params) req.send_request() 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.
569 570 571 572 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 569 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes a fleet. Prevents users from accessing previously associated websites.
592 593 594 595 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 592 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#describe_audit_stream_configuration(params = {}) ⇒ Types::DescribeAuditStreamConfigurationResponse
Describes the configuration for delivering audit streams to the customer account.
621 622 623 624 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 621 def describe_audit_stream_configuration(params = {}, = {}) req = build_request(:describe_audit_stream_configuration, params) req.send_request() end |
#describe_company_network_configuration(params = {}) ⇒ Types::DescribeCompanyNetworkConfigurationResponse
Describes the networking configuration to access the internal websites associated with the specified fleet.
656 657 658 659 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 656 def describe_company_network_configuration(params = {}, = {}) req = build_request(:describe_company_network_configuration, params) req.send_request() end |
#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse
Provides information about a user's device.
704 705 706 707 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 704 def describe_device(params = {}, = {}) req = build_request(:describe_device, params) req.send_request() end |
#describe_device_policy_configuration(params = {}) ⇒ Types::DescribeDevicePolicyConfigurationResponse
Describes the device policy configuration for the specified fleet.
732 733 734 735 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 732 def describe_device_policy_configuration(params = {}, = {}) req = build_request(:describe_device_policy_configuration, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Provides information about the domain.
772 773 774 775 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 772 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fleet_metadata(params = {}) ⇒ Types::DescribeFleetMetadataResponse
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
816 817 818 819 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 816 def (params = {}, = {}) req = build_request(:describe_fleet_metadata, params) req.send_request() end |
#describe_identity_provider_configuration(params = {}) ⇒ Types::DescribeIdentityProviderConfigurationResponse
Describes the identity provider configuration of the specified fleet.
848 849 850 851 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 848 def describe_identity_provider_configuration(params = {}, = {}) req = build_request(:describe_identity_provider_configuration, params) req.send_request() end |
#describe_website_certificate_authority(params = {}) ⇒ Types::DescribeWebsiteCertificateAuthorityResponse
Provides information about the certificate authority.
884 885 886 887 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 884 def (params = {}, = {}) req = build_request(:describe_website_certificate_authority, params) req.send_request() end |
#disassociate_domain(params = {}) ⇒ Struct
Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.
911 912 913 914 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 911 def disassociate_domain(params = {}, = {}) req = build_request(:disassociate_domain, params) req.send_request() 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.
939 940 941 942 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 939 def (params = {}, = {}) req = build_request(:disassociate_website_authorization_provider, params) req.send_request() end |
#disassociate_website_certificate_authority(params = {}) ⇒ Struct
Removes a certificate authority (CA).
965 966 967 968 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 965 def (params = {}, = {}) req = build_request(:disassociate_website_certificate_authority, params) req.send_request() 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.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1008 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() 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.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1053 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() 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.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1099 def list_fleets(params = {}, = {}) req = build_request(:list_fleets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for the specified resource.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1128 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1174 def (params = {}, = {}) req = build_request(:list_website_authorization_providers, params) req.send_request() 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.
1219 1220 1221 1222 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1219 def (params = {}, = {}) req = build_request(:list_website_certificate_authorities, params) req.send_request() end |
#restore_domain_access(params = {}) ⇒ Struct
Moves a domain to ACTIVE status if it was in the INACTIVE status.
1245 1246 1247 1248 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1245 def restore_domain_access(params = {}, = {}) req = build_request(:restore_domain_access, params) req.send_request() end |
#revoke_domain_access(params = {}) ⇒ Struct
Moves a domain to INACTIVE status if it was in the ACTIVE status.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1271 def revoke_domain_access(params = {}, = {}) req = build_request(:revoke_domain_access, params) req.send_request() 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1298 def sign_out_user(params = {}, = {}) req = build_request(:sign_out_user, params) req.send_request() 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1329 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
1355 1356 1357 1358 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1355 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_audit_stream_configuration(params = {}) ⇒ Struct
Updates the audit stream configuration for the fleet.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1382 def update_audit_stream_configuration(params = {}, = {}) req = build_request(:update_audit_stream_configuration, params) req.send_request() end |
#update_company_network_configuration(params = {}) ⇒ Struct
Updates the company network configuration for the fleet.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1417 def update_company_network_configuration(params = {}, = {}) req = build_request(:update_company_network_configuration, params) req.send_request() end |
#update_device_policy_configuration(params = {}) ⇒ Struct
Updates the device policy configuration for the fleet.
1445 1446 1447 1448 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1445 def update_device_policy_configuration(params = {}, = {}) req = build_request(:update_device_policy_configuration, params) req.send_request() end |
#update_domain_metadata(params = {}) ⇒ Struct
Updates domain metadata, such as DisplayName.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1475 def (params = {}, = {}) req = build_request(:update_domain_metadata, params) req.send_request() end |
#update_fleet_metadata(params = {}) ⇒ Struct
Updates fleet metadata, such as DisplayName.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1508 def (params = {}, = {}) req = build_request(:update_fleet_metadata, params) req.send_request() end |
#update_identity_provider_configuration(params = {}) ⇒ Struct
Updates the identity provider configuration for the fleet.
1540 1541 1542 1543 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1540 def update_identity_provider_configuration(params = {}, = {}) req = build_request(:update_identity_provider_configuration, params) req.send_request() end |