AWS SDK for PHP 3.x

Service ID: worklink

Version: 2018-09-25

This page describes the parameters and results for the operations of the Amazon WorkLink (2018-09-25), and shows how to use the Aws\WorkLink\WorkLinkClient object to call the described operations. This documentation is specific to the 2018-09-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateDomain ( array $params = [] ): Specifies a domain to be associated to Amazon WorkLink.
AssociateWebsiteAuthorizationProvider ( array $params = [] ): Associates a website authorization provider with a specified fleet.
AssociateWebsiteCertificateAuthority ( array $params = [] ): Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
CreateFleet ( array $params = [] ): Creates a fleet.
DeleteFleet ( array $params = [] ): Deletes a fleet.
DescribeAuditStreamConfiguration ( array $params = [] ): Describes the configuration for delivering audit streams to the customer account.
DescribeCompanyNetworkConfiguration ( array $params = [] ): Describes the networking configuration to access the internal websites associated with the specified fleet.
DescribeDevice ( array $params = [] ): Provides information about a user's device.
DescribeDevicePolicyConfiguration ( array $params = [] ): Describes the device policy configuration for the specified fleet.
DescribeDomain ( array $params = [] ): Provides information about the domain.
DescribeFleetMetadata ( array $params = [] ): Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
DescribeIdentityProviderConfiguration ( array $params = [] ): Describes the identity provider configuration of the specified fleet.
DescribeWebsiteCertificateAuthority ( array $params = [] ): Provides information about the certificate authority.
DisassociateDomain ( array $params = [] ): Disassociates a domain from Amazon WorkLink.
DisassociateWebsiteAuthorizationProvider ( array $params = [] ): Disassociates a website authorization provider from a specified fleet.
DisassociateWebsiteCertificateAuthority ( array $params = [] ): Removes a certificate authority (CA).
ListDevices ( array $params = [] ): Retrieves a list of devices registered with the specified fleet.
ListDomains ( array $params = [] ): Retrieves a list of domains associated to a specified fleet.
ListFleets ( array $params = [] ): Retrieves a list of fleets for the current account and Region.
ListTagsForResource ( array $params = [] ): Retrieves a list of tags for the specified resource.
ListWebsiteAuthorizationProviders ( array $params = [] ): Retrieves a list of website authorization providers associated with a specified fleet.
ListWebsiteCertificateAuthorities ( array $params = [] ): Retrieves a list of certificate authorities added for the current account and Region.
RestoreDomainAccess ( array $params = [] ): Moves a domain to ACTIVE status if it was in the INACTIVE status.
RevokeDomainAccess ( array $params = [] ): Moves a domain to INACTIVE status if it was in the ACTIVE status.
SignOutUser ( array $params = [] ): Signs the user out from all of their devices.
TagResource ( array $params = [] ): Adds or overwrites one or more tags for the specified resource, such as a fleet.
UntagResource ( array $params = [] ): Removes one or more tags from the specified resource.
UpdateAuditStreamConfiguration ( array $params = [] ): Updates the audit stream configuration for the fleet.
UpdateCompanyNetworkConfiguration ( array $params = [] ): Updates the company network configuration for the fleet.
UpdateDevicePolicyConfiguration ( array $params = [] ): Updates the device policy configuration for the fleet.
UpdateDomainMetadata ( array $params = [] ): Updates domain metadata, such as DisplayName.
UpdateFleetMetadata ( array $params = [] ): Updates fleet metadata, such as DisplayName.
UpdateIdentityProviderConfiguration ( array $params = [] ): Updates the identity provider configuration for the fleet.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDevices
ListDomains
ListFleets
ListWebsiteAuthorizationProviders
ListWebsiteCertificateAuthorities

Operations

AssociateDomain

$result = $client->associateDomain([/* ... */]);
$promise = $client->associateDomainAsync([/* ... */]);

Specifies a domain to be associated to Amazon WorkLink.

Parameter Syntax

$result = $client->associateDomain([
    'AcmCertificateArn' => '<string>', // REQUIRED
    'DisplayName' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcmCertificateArn

: Required: Yes
: Type: string

The ARN of an issued ACM certificate that is valid for the domain being associated.

DisplayName

: Type: string

The name to display.

DomainName

: Required: Yes
: Type: string

The fully qualified domain name (FQDN).

FleetArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
ResourceAlreadyExistsException:: The resource already exists.
TooManyRequestsException:: The number of requests exceeds the limit.

AssociateWebsiteAuthorizationProvider

$result = $client->associateWebsiteAuthorizationProvider([/* ... */]);
$promise = $client->associateWebsiteAuthorizationProviderAsync([/* ... */]);

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

Parameter Syntax

$result = $client->associateWebsiteAuthorizationProvider([
    'AuthorizationProviderType' => 'SAML', // REQUIRED
    'DomainName' => '<string>',
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AuthorizationProviderType

: Required: Yes
: Type: string

The authorization provider type.

DomainName

: Type: string

The domain name of the authorization provider. This applies only to SAML-based authorization providers.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'AuthorizationProviderId' => '<string>',
]

Result Details

Members

AuthorizationProviderId

: Type: string

A unique identifier for the authorization provider.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
ResourceAlreadyExistsException:: The resource already exists.
TooManyRequestsException:: The number of requests exceeds the limit.

AssociateWebsiteCertificateAuthority

$result = $client->associateWebsiteCertificateAuthority([/* ... */]);
$promise = $client->associateWebsiteCertificateAuthorityAsync([/* ... */]);

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

Parameter Syntax

$result = $client->associateWebsiteCertificateAuthority([
    'Certificate' => '<string>', // REQUIRED
    'DisplayName' => '<string>',
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Certificate

: Required: Yes
: Type: string

The root certificate of the CA.

DisplayName

: Type: string

The certificate name to display.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'WebsiteCaId' => '<string>',
]

Result Details

Members

WebsiteCaId

: Type: string

A unique identifier for the CA.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
ResourceAlreadyExistsException:: The resource already exists.
TooManyRequestsException:: The number of requests exceeds the limit.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createFleet([
    'DisplayName' => '<string>',
    'FleetName' => '<string>', // REQUIRED
    'OptimizeForEndUserLocation' => true || false,
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

DisplayName

: Type: string

The fleet name to display.

FleetName

: Required: Yes
: Type: string

A unique name for the fleet.

OptimizeForEndUserLocation

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

: Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource. A tag is a key-value pair.

Result Syntax

[
    'FleetArn' => '<string>',
]

Result Details

Members

FleetArn

: Type: string

The Amazon Resource Name (ARN) of the fleet.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
ResourceAlreadyExistsException:: The resource already exists.
TooManyRequestsException:: The number of requests exceeds the limit.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

Deletes a fleet. Prevents users from accessing previously associated websites.

Parameter Syntax

$result = $client->deleteFleet([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeAuditStreamConfiguration

$result = $client->describeAuditStreamConfiguration([/* ... */]);
$promise = $client->describeAuditStreamConfigurationAsync([/* ... */]);

Describes the configuration for delivering audit streams to the customer account.

Parameter Syntax

$result = $client->describeAuditStreamConfiguration([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'AuditStreamArn' => '<string>',
]

Result Details

Members

AuditStreamArn

: Type: string

The ARN of the Amazon Kinesis data stream that will receive the audit events.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeCompanyNetworkConfiguration

$result = $client->describeCompanyNetworkConfiguration([/* ... */]);
$promise = $client->describeCompanyNetworkConfigurationAsync([/* ... */]);

Describes the networking configuration to access the internal websites associated with the specified fleet.

Parameter Syntax

$result = $client->describeCompanyNetworkConfiguration([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'SecurityGroupIds' => ['<string>', ...],
    'SubnetIds' => ['<string>', ...],
    'VpcId' => '<string>',
]

Result Details

Members

SecurityGroupIds

: Type: Array of strings

The security groups associated with access to the provided subnets.

SubnetIds

: Type: Array of strings

The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

VpcId

: Type: string

The VPC with connectivity to associated websites.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeDevice

$result = $client->describeDevice([/* ... */]);
$promise = $client->describeDeviceAsync([/* ... */]);

Provides information about a user's device.

Parameter Syntax

$result = $client->describeDevice([
    'DeviceId' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceId

: Required: Yes
: Type: string

A unique identifier for a registered user's device.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'FirstAccessedTime' => <DateTime>,
    'LastAccessedTime' => <DateTime>,
    'Manufacturer' => '<string>',
    'Model' => '<string>',
    'OperatingSystem' => '<string>',
    'OperatingSystemVersion' => '<string>',
    'PatchLevel' => '<string>',
    'Status' => 'ACTIVE|SIGNED_OUT',
    'Username' => '<string>',
]

Result Details

Members

FirstAccessedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the device first signed in to Amazon WorkLink.

LastAccessedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the device last accessed Amazon WorkLink.

Manufacturer

: Type: string

The manufacturer of the device.

Model

: Type: string

The model of the device.

OperatingSystem

: Type: string

The operating system of the device.

OperatingSystemVersion

: Type: string

The operating system version of the device.

PatchLevel

: Type: string

The operating system patch level of the device.

Status

: Type: string

The current state of the device.

Username

: Type: string

The user name associated with the device.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeDevicePolicyConfiguration

$result = $client->describeDevicePolicyConfiguration([/* ... */]);
$promise = $client->describeDevicePolicyConfigurationAsync([/* ... */]);

Describes the device policy configuration for the specified fleet.

Parameter Syntax

$result = $client->describeDevicePolicyConfiguration([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'DeviceCaCertificate' => '<string>',
]

Result Details

Members

DeviceCaCertificate

: Type: string

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeDomain

$result = $client->describeDomain([/* ... */]);
$promise = $client->describeDomainAsync([/* ... */]);

Provides information about the domain.

Parameter Syntax

$result = $client->describeDomain([
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

: Required: Yes
: Type: string

The name of the domain.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'AcmCertificateArn' => '<string>',
    'CreatedTime' => <DateTime>,
    'DisplayName' => '<string>',
    'DomainName' => '<string>',
    'DomainStatus' => 'PENDING_VALIDATION|ASSOCIATING|ACTIVE|INACTIVE|DISASSOCIATING|DISASSOCIATED|FAILED_TO_ASSOCIATE|FAILED_TO_DISASSOCIATE',
]

Result Details

Members

AcmCertificateArn

: Type: string

The ARN of an issued ACM certificate that is valid for the domain being associated.

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the domain was added.

DisplayName

: Type: string

The name to display.

DomainName

: Type: string

The name of the domain.

DomainStatus

: Type: string

The current state for the domain.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeFleetMetadata

$result = $client->describeFleetMetadata([/* ... */]);
$promise = $client->describeFleetMetadataAsync([/* ... */]);

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

Parameter Syntax

$result = $client->describeFleetMetadata([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the fleet.

Result Syntax

[
    'CompanyCode' => '<string>',
    'CreatedTime' => <DateTime>,
    'DisplayName' => '<string>',
    'FleetName' => '<string>',
    'FleetStatus' => 'CREATING|ACTIVE|DELETING|DELETED|FAILED_TO_CREATE|FAILED_TO_DELETE',
    'LastUpdatedTime' => <DateTime>,
    'OptimizeForEndUserLocation' => true || false,
    'Tags' => ['<string>', ...],
]

Result Details

Members

CompanyCode

: Type: string

The identifier used by users to sign in to the Amazon WorkLink app.

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the fleet was created.

DisplayName

: Type: string

The name to display.

FleetName

: Type: string

The name of the fleet.

FleetStatus

: Type: string

The current state of the fleet.

LastUpdatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the fleet was last updated.

OptimizeForEndUserLocation

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

: Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the resource. A tag is a key-value pair.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeIdentityProviderConfiguration

$result = $client->describeIdentityProviderConfiguration([/* ... */]);
$promise = $client->describeIdentityProviderConfigurationAsync([/* ... */]);

Describes the identity provider configuration of the specified fleet.

Parameter Syntax

$result = $client->describeIdentityProviderConfiguration([
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[
    'IdentityProviderSamlMetadata' => '<string>',
    'IdentityProviderType' => 'SAML',
    'ServiceProviderSamlMetadata' => '<string>',
]

Result Details

Members

IdentityProviderSamlMetadata

: Type: string

The SAML metadata document provided by the user’s identity provider.

IdentityProviderType

: Type: string

The type of identity provider.

ServiceProviderSamlMetadata

: Type: string

The SAML metadata document uploaded to the user’s identity provider.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DescribeWebsiteCertificateAuthority

$result = $client->describeWebsiteCertificateAuthority([/* ... */]);
$promise = $client->describeWebsiteCertificateAuthorityAsync([/* ... */]);

Provides information about the certificate authority.

Parameter Syntax

$result = $client->describeWebsiteCertificateAuthority([
    'FleetArn' => '<string>', // REQUIRED
    'WebsiteCaId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

WebsiteCaId

: Required: Yes
: Type: string

A unique identifier for the certificate authority.

Result Syntax

[
    'Certificate' => '<string>',
    'CreatedTime' => <DateTime>,
    'DisplayName' => '<string>',
]

Result Details

Members

Certificate

: Type: string

The root certificate of the certificate authority.

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the certificate authority was added.

DisplayName

: Type: string

The certificate name to display.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DisassociateDomain

$result = $client->disassociateDomain([/* ... */]);
$promise = $client->disassociateDomainAsync([/* ... */]);

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

Parameter Syntax

$result = $client->disassociateDomain([
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

: Required: Yes
: Type: string

The name of the domain.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

DisassociateWebsiteAuthorizationProvider

$result = $client->disassociateWebsiteAuthorizationProvider([/* ... */]);
$promise = $client->disassociateWebsiteAuthorizationProviderAsync([/* ... */]);

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

Parameter Syntax

$result = $client->disassociateWebsiteAuthorizationProvider([
    'AuthorizationProviderId' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AuthorizationProviderId

: Required: Yes
: Type: string

A unique identifier for the authorization provider.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
ResourceAlreadyExistsException:: The resource already exists.
TooManyRequestsException:: The number of requests exceeds the limit.

DisassociateWebsiteCertificateAuthority

$result = $client->disassociateWebsiteCertificateAuthority([/* ... */]);
$promise = $client->disassociateWebsiteCertificateAuthorityAsync([/* ... */]);

Removes a certificate authority (CA).

Parameter Syntax

$result = $client->disassociateWebsiteCertificateAuthority([
    'FleetArn' => '<string>', // REQUIRED
    'WebsiteCaId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

WebsiteCaId

: Required: Yes
: Type: string

A unique identifier for the CA.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

ListDevices

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Retrieves a list of devices registered with the specified fleet.

Parameter Syntax

$result = $client->listDevices([
    'FleetArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

MaxResults

: Type: int

The maximum number of results to be included in the next page.

NextToken

: Type: 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.

Result Syntax

[
    'Devices' => [
        [
            'DeviceId' => '<string>',
            'DeviceStatus' => 'ACTIVE|SIGNED_OUT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Devices

: Type: Array of DeviceSummary structures

Information about the devices.

NextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Retrieves a list of domains associated to a specified fleet.

Parameter Syntax

$result = $client->listDomains([
    'FleetArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

MaxResults

: Type: int

The maximum number of results to be included in the next page.

NextToken

: Type: 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.

Result Syntax

[
    'Domains' => [
        [
            'CreatedTime' => <DateTime>,
            'DisplayName' => '<string>',
            'DomainName' => '<string>',
            'DomainStatus' => 'PENDING_VALIDATION|ASSOCIATING|ACTIVE|INACTIVE|DISASSOCIATING|DISASSOCIATED|FAILED_TO_ASSOCIATE|FAILED_TO_DISASSOCIATE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Domains

: Type: Array of DomainSummary structures

Information about the domains.

NextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

ListFleets

$result = $client->listFleets([/* ... */]);
$promise = $client->listFleetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listFleets([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of results to be included in the next page.

NextToken

: Type: 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.

Result Syntax

[
    'FleetSummaryList' => [
        [
            'CompanyCode' => '<string>',
            'CreatedTime' => <DateTime>,
            'DisplayName' => '<string>',
            'FleetArn' => '<string>',
            'FleetName' => '<string>',
            'FleetStatus' => 'CREATING|ACTIVE|DELETING|DELETED|FAILED_TO_CREATE|FAILED_TO_DELETE',
            'LastUpdatedTime' => <DateTime>,
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FleetSummaryList

: Type: Array of FleetSummary structures

The summary list of the fleets.

NextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
TooManyRequestsException:: The number of requests exceeds the limit.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves a list of tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the fleet.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the resource. A tag is a key-value pair.

Errors

InvalidRequestException:: The request is not valid.

ListWebsiteAuthorizationProviders

$result = $client->listWebsiteAuthorizationProviders([/* ... */]);
$promise = $client->listWebsiteAuthorizationProvidersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listWebsiteAuthorizationProviders([
    'FleetArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

MaxResults

: Type: int

The maximum number of results to be included in the next page.

NextToken

: Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'WebsiteAuthorizationProviders' => [
        [
            'AuthorizationProviderId' => '<string>',
            'AuthorizationProviderType' => 'SAML',
            'CreatedTime' => <DateTime>,
            'DomainName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: 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.

WebsiteAuthorizationProviders

: Type: Array of WebsiteAuthorizationProviderSummary structures

The website authorization providers.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

ListWebsiteCertificateAuthorities

$result = $client->listWebsiteCertificateAuthorities([/* ... */]);
$promise = $client->listWebsiteCertificateAuthoritiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listWebsiteCertificateAuthorities([
    'FleetArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

MaxResults

: Type: int

The maximum number of results to be included in the next page.

NextToken

: Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'WebsiteCertificateAuthorities' => [
        [
            'CreatedTime' => <DateTime>,
            'DisplayName' => '<string>',
            'WebsiteCaId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

WebsiteCertificateAuthorities

: Type: Array of WebsiteCaSummary structures

Information about the certificates.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
TooManyRequestsException:: The number of requests exceeds the limit.

RestoreDomainAccess

$result = $client->restoreDomainAccess([/* ... */]);
$promise = $client->restoreDomainAccessAsync([/* ... */]);

Moves a domain to ACTIVE status if it was in the INACTIVE status.

Parameter Syntax

$result = $client->restoreDomainAccess([
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

: Required: Yes
: Type: string

The name of the domain.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

RevokeDomainAccess

$result = $client->revokeDomainAccess([/* ... */]);
$promise = $client->revokeDomainAccessAsync([/* ... */]);

Moves a domain to INACTIVE status if it was in the ACTIVE status.

Parameter Syntax

$result = $client->revokeDomainAccess([
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

: Required: Yes
: Type: string

The name of the domain.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

SignOutUser

$result = $client->signOutUser([/* ... */]);
$promise = $client->signOutUserAsync([/* ... */]);

Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

Parameter Syntax

$result = $client->signOutUser([
    'FleetArn' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Username

: Required: Yes
: Type: string

The name of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the fleet.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource. A tag is a key-value pair.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:: The request is not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the fleet.

TagKeys

: Required: Yes
: Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:: The request is not valid.

UpdateAuditStreamConfiguration

$result = $client->updateAuditStreamConfiguration([/* ... */]);
$promise = $client->updateAuditStreamConfigurationAsync([/* ... */]);

Updates the audit stream configuration for the fleet.

Parameter Syntax

$result = $client->updateAuditStreamConfiguration([
    'AuditStreamArn' => '<string>',
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AuditStreamArn

: Type: string

The ARN of the Amazon Kinesis data stream that receives the audit events.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

UpdateCompanyNetworkConfiguration

$result = $client->updateCompanyNetworkConfiguration([/* ... */]);
$promise = $client->updateCompanyNetworkConfigurationAsync([/* ... */]);

Updates the company network configuration for the fleet.

Parameter Syntax

$result = $client->updateCompanyNetworkConfiguration([
    'FleetArn' => '<string>', // REQUIRED
    'SecurityGroupIds' => ['<string>', ...], // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

SecurityGroupIds

: Required: Yes
: Type: Array of strings

The security groups associated with access to the provided subnets.

SubnetIds

: Required: Yes
: Type: Array of strings

The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

VpcId

: Required: Yes
: Type: string

The VPC with connectivity to associated websites.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

UpdateDevicePolicyConfiguration

$result = $client->updateDevicePolicyConfiguration([/* ... */]);
$promise = $client->updateDevicePolicyConfigurationAsync([/* ... */]);

Updates the device policy configuration for the fleet.

Parameter Syntax

$result = $client->updateDevicePolicyConfiguration([
    'DeviceCaCertificate' => '<string>',
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceCaCertificate

: Type: string

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

UpdateDomainMetadata

$result = $client->updateDomainMetadata([/* ... */]);
$promise = $client->updateDomainMetadataAsync([/* ... */]);

Updates domain metadata, such as DisplayName.

Parameter Syntax

$result = $client->updateDomainMetadata([
    'DisplayName' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'FleetArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DisplayName

: Type: string

The name to display.

DomainName

: Required: Yes
: Type: string

The name of the domain.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

UpdateFleetMetadata

$result = $client->updateFleetMetadata([/* ... */]);
$promise = $client->updateFleetMetadataAsync([/* ... */]);

Updates fleet metadata, such as DisplayName.

Parameter Syntax

$result = $client->updateFleetMetadata([
    'DisplayName' => '<string>',
    'FleetArn' => '<string>', // REQUIRED
    'OptimizeForEndUserLocation' => true || false,
]);

Parameter Details

Members

DisplayName

: Type: string

The fleet name to display. The existing DisplayName is unset if null is passed.

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

OptimizeForEndUserLocation

: Type: 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

UpdateIdentityProviderConfiguration

$result = $client->updateIdentityProviderConfiguration([/* ... */]);
$promise = $client->updateIdentityProviderConfigurationAsync([/* ... */]);

Updates the identity provider configuration for the fleet.

Parameter Syntax

$result = $client->updateIdentityProviderConfiguration([
    'FleetArn' => '<string>', // REQUIRED
    'IdentityProviderSamlMetadata' => '<string>',
    'IdentityProviderType' => 'SAML', // REQUIRED
]);

Parameter Details

Members

FleetArn

: Required: Yes
: Type: string

The ARN of the fleet.

IdentityProviderSamlMetadata

: Type: string

The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.

IdentityProviderType

: Required: Yes
: Type: string

The type of identity provider.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:: You are not authorized to perform this action.
InternalServerErrorException:: The service is temporarily unavailable.
InvalidRequestException:: The request is not valid.
ResourceNotFoundException:: The requested resource was not found.
TooManyRequestsException:: The number of requests exceeds the limit.

Shapes

DeviceSummary

Description

The summary of devices.

Members

DeviceId

: Type: string

The ID of the device.

DeviceStatus

: Type: string

The status of the device.

DomainSummary

Description

The summary of the domain.

Members

CreatedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the domain was created.

DisplayName

: Type: string

The name to display.

DomainName

: Required: Yes
: Type: string

The name of the domain.

DomainStatus

: Required: Yes
: Type: string

The status of the domain.

FleetSummary

Description

The summary of the fleet.

Members

CompanyCode

: Type: string

The identifier used by users to sign into the Amazon WorkLink app.

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the fleet was created.

DisplayName

: Type: string

The name of the fleet to display.

FleetArn

: Type: string

The Amazon Resource Name (ARN) of the fleet.

FleetName

: Type: string

The name of the fleet.

FleetStatus

: Type: string

The status of the fleet.

LastUpdatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the fleet was last updated.

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

: Type: string

A unique identifier for the authorization provider.

AuthorizationProviderType

: Required: Yes
: Type: string

The authorization provider type.

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of creation.

DomainName

: Type: string

The domain name of the authorization provider. This applies only to SAML-based authorization providers.

WebsiteCaSummary

Description

The summary of the certificate authority (CA).

Members

CreatedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the CA was added.

DisplayName

: Type: string

The name to display.

WebsiteCaId

: Type: string

A unique identifier for the CA.

Amazon WorkLink 2018-09-25

Operation Summary

Paginators

Operations

AssociateDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateWebsiteAuthorizationProvider

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateWebsiteCertificateAuthority

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFleet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteFleet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeAuditStreamConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCompanyNetworkConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeDevicePolicyConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details