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.
365 366 367 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#associate_domain(params = {}) ⇒ Struct
Specifies a domain to be associated to Amazon WorkLink.
401 402 403 404 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 401 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.
440 441 442 443 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 440 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.
478 479 480 481 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 478 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.
524 525 526 527 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 524 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.
547 548 549 550 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 547 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.
576 577 578 579 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 576 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.
611 612 613 614 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 611 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.
659 660 661 662 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 659 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.
687 688 689 690 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 687 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.
727 728 729 730 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 727 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.
771 772 773 774 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 771 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.
803 804 805 806 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 803 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.
839 840 841 842 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 839 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.
866 867 868 869 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 866 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.
894 895 896 897 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 894 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).
920 921 922 923 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 920 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.
963 964 965 966 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 963 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.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1008 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1054 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.
1083 1084 1085 1086 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1083 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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1129 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.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1174 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.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1200 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.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1226 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1253 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.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1284 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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1310 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.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1337 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.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1372 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1400 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1430 def (params = {}, = {}) req = build_request(:update_domain_metadata, params) req.send_request() end |
#update_fleet_metadata(params = {}) ⇒ Struct
Updates fleet metadata, such as DisplayName.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1463 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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-worklink/lib/aws-sdk-worklink/client.rb', line 1495 def update_identity_provider_configuration(params = {}, = {}) req = build_request(:update_identity_provider_configuration, params) req.send_request() end |