2019/01/23 - Amazon WorkLink - 20 new api methods
Changes Update worklink client to latest version
Updates the identity provider configuration for the fleet.
See also: AWS API Documentation
Request Syntax
client.update_identity_provider_configuration(
FleetArn='string',
IdentityProviderType='SAML',
IdentityProviderSamlMetadata='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The type of identity provider.
string
The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of devices registered with the specified fleet.
See also: AWS API Documentation
Request Syntax
client.list_devices(
FleetArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ARN of the fleet.
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.
integer
The maximum number of results to be included in the next page.
dict
Response Syntax
{
'Devices': [
{
'DeviceId': 'string',
'DeviceStatus': 'ACTIVE'|'SIGNED_OUT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Devices (list) --
Information about the devices.
(dict) --
The summary of devices.
DeviceId (string) --
The ID of the device.
DeviceStatus (string) --
The status of the device.
NextToken (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.
Updates the audit stream configuration for the fleet.
See also: AWS API Documentation
Request Syntax
client.update_audit_stream_configuration(
FleetArn='string',
AuditStreamArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
The ARN of the Amazon Kinesis data stream that receives the audit events.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the configuration for delivering audit streams to the customer account.
See also: AWS API Documentation
Request Syntax
client.describe_audit_stream_configuration(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'AuditStreamArn': 'string'
}
Response Structure
(dict) --
AuditStreamArn (string) --
The ARN of the Amazon Kinesis data stream that will receive the audit events.
Updates fleet metadata, such as DisplayName.
See also: AWS API Documentation
Request Syntax
client.update_fleet_metadata(
FleetArn='string',
DisplayName='string',
OptimizeForEndUserLocation=True|False
)
string
[REQUIRED]
The ARN of the fleet.
string
The fleet name to display. The existing DisplayName is unset if null is passed.
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the identity provider configuration of the specified fleet.
See also: AWS API Documentation
Request Syntax
client.describe_identity_provider_configuration(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'IdentityProviderType': 'SAML',
'ServiceProviderSamlMetadata': 'string',
'IdentityProviderSamlMetadata': 'string'
}
Response Structure
(dict) --
IdentityProviderType (string) --
The type of identity provider.
ServiceProviderSamlMetadata (string) --
The SAML metadata document uploaded to the user’s identity provider.
IdentityProviderSamlMetadata (string) --
The SAML metadata document provided by the user’s identity provider.
Provides information about the certificate authority.
See also: AWS API Documentation
Request Syntax
client.describe_website_certificate_authority(
FleetArn='string',
WebsiteCaId='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
A unique identifier for the certificate authority.
dict
Response Syntax
{
'Certificate': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DisplayName': 'string'
}
Response Structure
(dict) --
Certificate (string) --
The root certificate of the certificate authority.
CreatedTime (datetime) --
The time that the certificate authority was added.
DisplayName (string) --
The certificate name to display.
Describes the networking configuration to access the internal websites associated with the specified fleet.
See also: AWS API Documentation
Request Syntax
client.describe_company_network_configuration(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
}
Response Structure
(dict) --
VpcId (string) --
The VPC with connectivity to associated websites.
SubnetIds (list) --
The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
(string) --
SecurityGroupIds (list) --
The security groups associated with access to the provided subnets.
(string) --
Retrieves a list of fleets for the current account and Region.
See also: AWS API Documentation
Request Syntax
client.list_fleets(
NextToken='string',
MaxResults=123
)
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.
integer
The maximum number of results to be included in the next page.
dict
Response Syntax
{
'FleetSummaryList': [
{
'FleetArn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'FleetName': 'string',
'DisplayName': 'string',
'CompanyCode': 'string',
'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetSummaryList (list) --
The summary list of the fleets.
(dict) --
The summary of the fleet.
FleetArn (string) --
The ARN of the fleet.
CreatedTime (datetime) --
The time when the fleet was created.
LastUpdatedTime (datetime) --
The time when the fleet was last updated.
FleetName (string) --
The name of the fleet.
DisplayName (string) --
The name to display.
CompanyCode (string) --
The identifier used by users to sign into the Amazon WorkLink app.
FleetStatus (string) --
The status of the fleet.
NextToken (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.
Describes the device policy configuration for the specified fleet.
See also: AWS API Documentation
Request Syntax
client.describe_device_policy_configuration(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'DeviceCaCertificate': 'string'
}
Response Structure
(dict) --
DeviceCaCertificate (string) --
The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
Retrieves a list of certificate authorities added for the current account and Region.
See also: AWS API Documentation
Request Syntax
client.list_website_certificate_authorities(
FleetArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the fleet.
integer
The maximum number of results to be included in the next page.
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.
dict
Response Syntax
{
'WebsiteCertificateAuthorities': [
{
'WebsiteCaId': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DisplayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WebsiteCertificateAuthorities (list) --
Information about the certificates.
(dict) --
The summary of the certificate authority (CA).
WebsiteCaId (string) --
A unique identifier for the CA.
CreatedTime (datetime) --
The time when the CA was added.
DisplayName (string) --
The name to display.
NextToken (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.
Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.
See also: AWS API Documentation
Request Syntax
client.associate_website_certificate_authority(
FleetArn='string',
Certificate='string',
DisplayName='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The root certificate of the CA.
string
The certificate name to display.
dict
Response Syntax
{
'WebsiteCaId': 'string'
}
Response Structure
(dict) --
WebsiteCaId (string) --
A unique identifier for the CA.
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.
See also: AWS API Documentation
Request Syntax
client.create_fleet(
FleetName='string',
DisplayName='string',
OptimizeForEndUserLocation=True|False
)
string
[REQUIRED]
A unique name for the fleet.
string
The fleet name to display.
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.
dict
Response Syntax
{
'FleetArn': 'string'
}
Response Structure
(dict) --
FleetArn (string) --
The ARN of the fleet.
Signs the user out from all of their devices. The user can sign in again if they have valid credentials.
See also: AWS API Documentation
Request Syntax
client.sign_out_user(
FleetArn='string',
Username='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The name of the user.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the device policy configuration for the fleet.
See also: AWS API Documentation
Request Syntax
client.update_device_policy_configuration(
FleetArn='string',
DeviceCaCertificate='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
dict
Response Syntax
{}
Response Structure
(dict) --
Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_metadata(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'FleetName': 'string',
'DisplayName': 'string',
'OptimizeForEndUserLocation': True|False,
'CompanyCode': 'string',
'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE'
}
Response Structure
(dict) --
CreatedTime (datetime) --
The time that the fleet was created.
LastUpdatedTime (datetime) --
The time that the fleet was last updated.
FleetName (string) --
The name of the fleet.
DisplayName (string) --
The name to display.
OptimizeForEndUserLocation (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.
CompanyCode (string) --
The identifier used by users to sign in to the Amazon WorkLink app.
FleetStatus (string) --
The current state of the fleet.
Updates the company network configuration for the fleet.
See also: AWS API Documentation
Request Syntax
client.update_company_network_configuration(
FleetArn='string',
VpcId='string',
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
]
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
The VPC with connectivity to associated websites.
list
[REQUIRED]
The subnets used for X-ENI connections from Amazon WorkLink rendering containers.
(string) --
list
[REQUIRED]
The security groups associated with access to the provided subnets.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a fleet. Prevents users from accessing previously associated websites.
See also: AWS API Documentation
Request Syntax
client.delete_fleet(
FleetArn='string'
)
string
[REQUIRED]
The ARN of the fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
Provides information about a user's device.
See also: AWS API Documentation
Request Syntax
client.describe_device(
FleetArn='string',
DeviceId='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
A unique identifier for a registered user's device.
dict
Response Syntax
{
'Status': 'ACTIVE'|'SIGNED_OUT',
'Model': 'string',
'Manufacturer': 'string',
'OperatingSystem': 'string',
'OperatingSystemVersion': 'string',
'PatchLevel': 'string',
'FirstAccessedTime': datetime(2015, 1, 1),
'LastAccessedTime': datetime(2015, 1, 1),
'Username': 'string'
}
Response Structure
(dict) --
Status (string) --
The current state of the device.
Model (string) --
The model of the device.
Manufacturer (string) --
The manufacturer of the device.
OperatingSystem (string) --
The operating system of the device.
OperatingSystemVersion (string) --
The operating system version of the device.
PatchLevel (string) --
The operating system patch level of the device.
FirstAccessedTime (datetime) --
The date that the device first signed in to Amazon WorkLink.
LastAccessedTime (datetime) --
The date that the device last accessed Amazon WorkLink.
Username (string) --
The user name associated with the device.
Removes a certificate authority (CA).
See also: AWS API Documentation
Request Syntax
client.disassociate_website_certificate_authority(
FleetArn='string',
WebsiteCaId='string'
)
string
[REQUIRED]
The ARN of the fleet.
string
[REQUIRED]
A unique identifier for the CA.
dict
Response Syntax
{}
Response Structure
(dict) --