{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-worklink","description":"Amazon WorkLink","version":"2018-09-25","base_url":"","endpoints":33,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon WorkLink\n@version 2018-09-25\n@auth AWS SigV4\n@endpoints 33\n@hint download_for_search\n@toc associateDomain(1), associateWebsiteAuthorizationProvider(1), associateWebsiteCertificateAuthority(1), createFleet(1), deleteFleet(1), describeAuditStreamConfiguration(1), describeCompanyNetworkConfiguration(1), describeDevice(1), describeDevicePolicyConfiguration(1), describeDomain(1), describeFleetMetadata(1), describeIdentityProviderConfiguration(1), describeWebsiteCertificateAuthority(1), disassociateDomain(1), disassociateWebsiteAuthorizationProvider(1), disassociateWebsiteCertificateAuthority(1), listDevices(1), listDomains(1), listFleets(1), tags(3), listWebsiteAuthorizationProviders(1), listWebsiteCertificateAuthorities(1), restoreDomainAccess(1), revokeDomainAccess(1), signOutUser(1), updateAuditStreamConfiguration(1), updateCompanyNetworkConfiguration(1), updateDevicePolicyConfiguration(1), updateDomainMetadata(1), UpdateFleetMetadata(1), updateIdentityProviderConfiguration(1)\n\n@group associateDomain\n@endpoint POST /associateDomain\n@desc Specifies a domain to be associated to Amazon WorkLink.\n@required {FleetArn: str, DomainName: str, AcmCertificateArn: str}\n@optional {DisplayName: str}\n\n@endgroup\n\n@group associateWebsiteAuthorizationProvider\n@endpoint POST /associateWebsiteAuthorizationProvider\n@desc Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.\n@required {FleetArn: str, AuthorizationProviderType: str}\n@optional {DomainName: str}\n@returns(200) {AuthorizationProviderId: str?}\n\n@endgroup\n\n@group associateWebsiteCertificateAuthority\n@endpoint POST /associateWebsiteCertificateAuthority\n@desc Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.\n@required {FleetArn: str, Certificate: str}\n@optional {DisplayName: str}\n@returns(200) {WebsiteCaId: str?}\n\n@endgroup\n\n@group createFleet\n@endpoint POST /createFleet\n@desc 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.\n@required {FleetName: str}\n@optional {DisplayName: str, OptimizeForEndUserLocation: bool, Tags: map<str,str>}\n@returns(200) {FleetArn: str?}\n\n@endgroup\n\n@group deleteFleet\n@endpoint POST /deleteFleet\n@desc Deletes a fleet. Prevents users from accessing previously associated websites.\n@required {FleetArn: str}\n\n@endgroup\n\n@group describeAuditStreamConfiguration\n@endpoint POST /describeAuditStreamConfiguration\n@desc Describes the configuration for delivering audit streams to the customer account.\n@required {FleetArn: str}\n@returns(200) {AuditStreamArn: str?}\n\n@endgroup\n\n@group describeCompanyNetworkConfiguration\n@endpoint POST /describeCompanyNetworkConfiguration\n@desc Describes the networking configuration to access the internal websites associated with the specified fleet.\n@required {FleetArn: str}\n@returns(200) {VpcId: str?, SubnetIds: [str]?, SecurityGroupIds: [str]?}\n\n@endgroup\n\n@group describeDevice\n@endpoint POST /describeDevice\n@desc Provides information about a user's device.\n@required {FleetArn: str, DeviceId: str}\n@returns(200) {Status: str?, Model: str?, Manufacturer: str?, OperatingSystem: str?, OperatingSystemVersion: str?, PatchLevel: str?, FirstAccessedTime: str(timestamp)?, LastAccessedTime: str(timestamp)?, Username: str?}\n\n@endgroup\n\n@group describeDevicePolicyConfiguration\n@endpoint POST /describeDevicePolicyConfiguration\n@desc Describes the device policy configuration for the specified fleet.\n@required {FleetArn: str}\n@returns(200) {DeviceCaCertificate: str?}\n\n@endgroup\n\n@group describeDomain\n@endpoint POST /describeDomain\n@desc Provides information about the domain.\n@required {FleetArn: str, DomainName: str}\n@returns(200) {DomainName: str?, DisplayName: str?, CreatedTime: str(timestamp)?, DomainStatus: str?, AcmCertificateArn: str?}\n\n@endgroup\n\n@group describeFleetMetadata\n@endpoint POST /describeFleetMetadata\n@desc Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.\n@required {FleetArn: str}\n@returns(200) {CreatedTime: str(timestamp)?, LastUpdatedTime: str(timestamp)?, FleetName: str?, DisplayName: str?, OptimizeForEndUserLocation: bool?, CompanyCode: str?, FleetStatus: str?, Tags: map<str,str>?}\n\n@endgroup\n\n@group describeIdentityProviderConfiguration\n@endpoint POST /describeIdentityProviderConfiguration\n@desc Describes the identity provider configuration of the specified fleet.\n@required {FleetArn: str}\n@returns(200) {IdentityProviderType: str?, ServiceProviderSamlMetadata: str?, IdentityProviderSamlMetadata: str?}\n\n@endgroup\n\n@group describeWebsiteCertificateAuthority\n@endpoint POST /describeWebsiteCertificateAuthority\n@desc Provides information about the certificate authority.\n@required {FleetArn: str, WebsiteCaId: str}\n@returns(200) {Certificate: str?, CreatedTime: str(timestamp)?, DisplayName: str?}\n\n@endgroup\n\n@group disassociateDomain\n@endpoint POST /disassociateDomain\n@desc Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.\n@required {FleetArn: str, DomainName: str}\n\n@endgroup\n\n@group disassociateWebsiteAuthorizationProvider\n@endpoint POST /disassociateWebsiteAuthorizationProvider\n@desc Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.\n@required {FleetArn: str, AuthorizationProviderId: str}\n\n@endgroup\n\n@group disassociateWebsiteCertificateAuthority\n@endpoint POST /disassociateWebsiteCertificateAuthority\n@desc Removes a certificate authority (CA).\n@required {FleetArn: str, WebsiteCaId: str}\n\n@endgroup\n\n@group listDevices\n@endpoint POST /listDevices\n@desc Retrieves a list of devices registered with the specified fleet.\n@required {FleetArn: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {Devices: [DeviceSummary]?, NextToken: str?}\n\n@endgroup\n\n@group listDomains\n@endpoint POST /listDomains\n@desc Retrieves a list of domains associated to a specified fleet.\n@required {FleetArn: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {Domains: [DomainSummary]?, NextToken: str?}\n\n@endgroup\n\n@group listFleets\n@endpoint POST /listFleets\n@desc Retrieves a list of fleets for the current account and Region.\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {FleetSummaryList: [FleetSummary]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{ResourceArn}\n@desc Retrieves a list of tags for the specified resource.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group listWebsiteAuthorizationProviders\n@endpoint POST /listWebsiteAuthorizationProviders\n@desc Retrieves a list of website authorization providers associated with a specified fleet.\n@required {FleetArn: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {WebsiteAuthorizationProviders: [WebsiteAuthorizationProviderSummary]?, NextToken: str?}\n\n@endgroup\n\n@group listWebsiteCertificateAuthorities\n@endpoint POST /listWebsiteCertificateAuthorities\n@desc Retrieves a list of certificate authorities added for the current account and Region.\n@required {FleetArn: str}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {WebsiteCertificateAuthorities: [WebsiteCaSummary]?, NextToken: str?}\n\n@endgroup\n\n@group restoreDomainAccess\n@endpoint POST /restoreDomainAccess\n@desc Moves a domain to ACTIVE status if it was in the INACTIVE status.\n@required {FleetArn: str, DomainName: str}\n\n@endgroup\n\n@group revokeDomainAccess\n@endpoint POST /revokeDomainAccess\n@desc Moves a domain to INACTIVE status if it was in the ACTIVE status.\n@required {FleetArn: str, DomainName: str}\n\n@endgroup\n\n@group signOutUser\n@endpoint POST /signOutUser\n@desc Signs the user out from all of their devices. The user can sign in again if they have valid credentials.\n@required {FleetArn: str, Username: str}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{ResourceArn}\n@desc 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.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{ResourceArn}\n@desc Removes one or more tags from the specified resource.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group updateAuditStreamConfiguration\n@endpoint POST /updateAuditStreamConfiguration\n@desc Updates the audit stream configuration for the fleet.\n@required {FleetArn: str}\n@optional {AuditStreamArn: str}\n\n@endgroup\n\n@group updateCompanyNetworkConfiguration\n@endpoint POST /updateCompanyNetworkConfiguration\n@desc Updates the company network configuration for the fleet.\n@required {FleetArn: str, VpcId: str, SubnetIds: [str], SecurityGroupIds: [str]}\n\n@endgroup\n\n@group updateDevicePolicyConfiguration\n@endpoint POST /updateDevicePolicyConfiguration\n@desc Updates the device policy configuration for the fleet.\n@required {FleetArn: str}\n@optional {DeviceCaCertificate: str}\n\n@endgroup\n\n@group updateDomainMetadata\n@endpoint POST /updateDomainMetadata\n@desc Updates domain metadata, such as DisplayName.\n@required {FleetArn: str, DomainName: str}\n@optional {DisplayName: str}\n\n@endgroup\n\n@group UpdateFleetMetadata\n@endpoint POST /UpdateFleetMetadata\n@desc Updates fleet metadata, such as DisplayName.\n@required {FleetArn: str}\n@optional {DisplayName: str, OptimizeForEndUserLocation: bool}\n\n@endgroup\n\n@group updateIdentityProviderConfiguration\n@endpoint POST /updateIdentityProviderConfiguration\n@desc Updates the identity provider configuration for the fleet.\n@required {FleetArn: str, IdentityProviderType: str}\n@optional {IdentityProviderSamlMetadata: str}\n\n@endgroup\n\n@end\n"}