"documentation":"<p>Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.</p>"
"documentation":"<p>Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.</p>"
},
"CreateFleet":{
"name":"CreateFleet",
"http":{
"method":"POST",
"requestUri":"/createFleet"
},
"input":{"shape":"CreateFleetRequest"},
"output":{"shape":"CreateFleetResponse"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"InternalServerErrorException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>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.</p>"
},
"DeleteFleet":{
"name":"DeleteFleet",
"http":{
"method":"POST",
"requestUri":"/deleteFleet"
},
"input":{"shape":"DeleteFleetRequest"},
"output":{"shape":"DeleteFleetResponse"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"InternalServerErrorException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Deletes a fleet. Prevents users from accessing previously associated websites. </p>"
"documentation":"<p>Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.</p>"
"documentation":"<p>Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.</p>"
"documentation":"<p>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.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{ResourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Removes one or more tags from the specified resource.</p>"
"documentation":"<p>A unique name for the fleet.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The fleet name to display.</p>"
},
"OptimizeForEndUserLocation":{
"shape":"Boolean",
"documentation":"<p>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.</p>"
"documentation":"<p>The ARN of the Amazon Kinesis data stream that will receive the audit events.</p>"
}
}
},
"DescribeCompanyNetworkConfigurationRequest":{
"type":"structure",
"required":["FleetArn"],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
}
}
},
"DescribeCompanyNetworkConfigurationResponse":{
"type":"structure",
"members":{
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The VPC with connectivity to associated websites.</p>"
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>The subnets used for X-ENI connections from Amazon WorkLink rendering containers.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>The security groups associated with access to the provided subnets.</p>"
}
}
},
"DescribeDevicePolicyConfigurationRequest":{
"type":"structure",
"required":["FleetArn"],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
}
}
},
"DescribeDevicePolicyConfigurationResponse":{
"type":"structure",
"members":{
"DeviceCaCertificate":{
"shape":"Certificate",
"documentation":"<p>The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.</p>"
}
}
},
"DescribeDeviceRequest":{
"type":"structure",
"required":[
"FleetArn",
"DeviceId"
],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
},
"DeviceId":{
"shape":"Id",
"documentation":"<p>A unique identifier for a registered user's device.</p>"
}
}
},
"DescribeDeviceResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"DeviceStatus",
"documentation":"<p>The current state of the device.</p>"
},
"Model":{
"shape":"DeviceModel",
"documentation":"<p>The model of the device.</p>"
},
"Manufacturer":{
"shape":"DeviceManufacturer",
"documentation":"<p>The manufacturer of the device.</p>"
},
"OperatingSystem":{
"shape":"DeviceOperatingSystemName",
"documentation":"<p>The operating system of the device.</p>"
},
"OperatingSystemVersion":{
"shape":"DeviceOperatingSystemVersion",
"documentation":"<p>The operating system version of the device.</p>"
},
"PatchLevel":{
"shape":"DevicePatchLevel",
"documentation":"<p>The operating system patch level of the device.</p>"
},
"FirstAccessedTime":{
"shape":"DateTime",
"documentation":"<p>The date that the device first signed in to Amazon WorkLink.</p>"
},
"LastAccessedTime":{
"shape":"DateTime",
"documentation":"<p>The date that the device last accessed Amazon WorkLink.</p>"
},
"Username":{
"shape":"Username",
"documentation":"<p>The user name associated with the device.</p>"
"documentation":"<p>The time that the fleet was created.</p>"
},
"LastUpdatedTime":{
"shape":"DateTime",
"documentation":"<p>The time that the fleet was last updated.</p>"
},
"FleetName":{
"shape":"FleetName",
"documentation":"<p>The name of the fleet.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The name to display.</p>"
},
"OptimizeForEndUserLocation":{
"shape":"Boolean",
"documentation":"<p>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.</p>"
},
"CompanyCode":{
"shape":"CompanyCode",
"documentation":"<p>The identifier used by users to sign in to the Amazon WorkLink app.</p>"
},
"FleetStatus":{
"shape":"FleetStatus",
"documentation":"<p>The current state of the fleet.</p>"
"documentation":"<p>The summary of the fleet.</p>"
},
"FleetSummaryList":{
"type":"list",
"member":{"shape":"FleetSummary"}
},
"Id":{
"type":"string",
"max":256,
"min":1
},
"IdentityProviderType":{
"type":"string",
"enum":["SAML"]
},
"InternalServerErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The service is temporarily unavailable.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The request is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ListDevicesRequest":{
"type":"structure",
"required":["FleetArn"],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be included in the next page.</p>"
}
}
},
"ListDevicesResponse":{
"type":"structure",
"members":{
"Devices":{
"shape":"DeviceSummaryList",
"documentation":"<p>Information about the devices.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>"
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be included in the next page.</p>"
}
}
},
"ListDomainsResponse":{
"type":"structure",
"members":{
"Domains":{
"shape":"DomainSummaryList",
"documentation":"<p>Information about the domains.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>"
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be included in the next page.</p>"
}
}
},
"ListFleetsResponse":{
"type":"structure",
"members":{
"FleetSummaryList":{
"shape":"FleetSummaryList",
"documentation":"<p>The summary list of the fleets.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>"
"documentation":"<p>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.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be included in the next page.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The maximum number of results to be included in the next page.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>"
}
}
},
"ListWebsiteCertificateAuthoritiesResponse":{
"type":"structure",
"members":{
"WebsiteCertificateAuthorities":{
"shape":"WebsiteCaSummaryList",
"documentation":"<p>Information about the certificates.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>"
"documentation":"<p>The ARN of the Amazon Kinesis data stream that receives the audit events.</p>"
}
}
},
"UpdateAuditStreamConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdateCompanyNetworkConfigurationRequest":{
"type":"structure",
"required":[
"FleetArn",
"VpcId",
"SubnetIds",
"SecurityGroupIds"
],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The VPC with connectivity to associated websites.</p>"
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>The subnets used for X-ENI connections from Amazon WorkLink rendering containers.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>The security groups associated with access to the provided subnets.</p>"
}
}
},
"UpdateCompanyNetworkConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdateDevicePolicyConfigurationRequest":{
"type":"structure",
"required":["FleetArn"],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
},
"DeviceCaCertificate":{
"shape":"CertificateChain",
"documentation":"<p>The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.</p>"
"documentation":"<p>The fleet name to display. The existing DisplayName is unset if null is passed.</p>"
},
"OptimizeForEndUserLocation":{
"shape":"Boolean",
"documentation":"<p>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.</p>"
}
}
},
"UpdateFleetMetadataResponse":{
"type":"structure",
"members":{
}
},
"UpdateIdentityProviderConfigurationRequest":{
"type":"structure",
"required":[
"FleetArn",
"IdentityProviderType"
],
"members":{
"FleetArn":{
"shape":"FleetArn",
"documentation":"<p>The ARN of the fleet.</p>"
},
"IdentityProviderType":{
"shape":"IdentityProviderType",
"documentation":"<p>The type of identity provider.</p>"
},
"IdentityProviderSamlMetadata":{
"shape":"SamlMetadata",
"documentation":"<p>The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.</p>"
"documentation":"<p>Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.</p>"