# Data retrieval APIs for Amazon WorkSpaces
<a name="amazonworkspaces"></a>

Amazon WorkSpaces provides the following APIs for data retrieval.


****  

| Actions | Description | Access level | 
| --- | --- | --- | 
| <a name="workspaces-DescribeAccount"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeAccount.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeAccount.html) | Retrieve the configuration of Bring Your Own License (BYOL) for WorkSpaces accounts | Read | 
| <a name="workspaces-DescribeAccountModifications"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeAccountModifications.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeAccountModifications.html) | Retrieve modifications to the configuration of Bring Your Own License (BYOL) for WorkSpaces accounts | Read | 
| <a name="workspaces-DescribeApplicationAssociations"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeApplicationAssociations.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeApplicationAssociations.html) | Retrieve information about resources associated with a WorkSpace application | List | 
| <a name="workspaces-DescribeApplications"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeApplications.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeApplications.html) | Obtain information about WorkSpace applications | List | 
| <a name="workspaces-DescribeBundleAssociations"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeBundleAssociations.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeBundleAssociations.html) | Retrieve information about resources associated with a WorkSpace bundle | List | 
| <a name="workspaces-DescribeClientBranding"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeClientBranding.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeClientBranding.html) | Retrieve AWS WorkSpaces Client branding data within a directory | Read | 
| <a name="workspaces-DescribeClientProperties"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeClientProperties.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeClientProperties.html) | Retrieve information about WorkSpaces clients | List | 
| <a name="workspaces-DescribeConnectClientAddIns"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectClientAddIns.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectClientAddIns.html) | Retrieve a list of Amazon Connect client add-ins that have been created | List | 
| <a name="workspaces-DescribeConnectionAliasPermissions"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliasPermissions.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliasPermissions.html) | Retrieve the permissions that the owners of connection aliases have granted to other AWS accounts for connection aliases | Read | 
| <a name="workspaces-DescribeConnectionAliases"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) | Retrieve a list that describes the connection aliases used for cross-Region redirection | Read | 
| <a name="workspaces-DescribeConsent"></a>[https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-console-permissions-ref.html](https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-console-permissions-ref.html) | Retrieve information about consent agreement to BYOL minimum requirements | Read | 
| <a name="workspaces-DescribeCustomWorkspaceImageImport"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeCustomWorkspaceImageImport.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeCustomWorkspaceImageImport.html) | Retrieve information about WorkSpace BYOL image import task | Read | 
| <a name="workspaces-DescribeImageAssociations"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeImageAssociations.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeImageAssociations.html) | Retrieve information about resources associated with a WorkSpace image | List | 
| <a name="workspaces-DescribeIpGroups"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeIpGroups.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeIpGroups.html) | Retrieve information about IP access control groups | Read | 
| <a name="workspaces-DescribeTags"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeTags.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeTags.html) | Describe the tags for WorkSpaces resources | Read | 
| <a name="workspaces-DescribeWorkspaceAssociations"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceAssociations.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceAssociations.html) | Retrieve information about resources associated with a WorkSpace | List | 
| <a name="workspaces-DescribeWorkspaceBundles"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceBundles.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceBundles.html) | Obtain information about WorkSpace bundles | List | 
| <a name="workspaces-DescribeWorkspaceDirectories"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html) | Retrieve information about directories that are registered with WorkSpaces | Read | 
| <a name="workspaces-DescribeWorkspaceImagePermissions"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) | Retrieve information about WorkSpace image permissions | Read | 
| <a name="workspaces-DescribeWorkspaceImages"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) | Retrieve information about WorkSpace images | List | 
| <a name="workspaces-DescribeWorkspaceSnapshots"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceSnapshots.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceSnapshots.html) | Retrieve information about WorkSpace snapshots | List | 
| <a name="workspaces-DescribeWorkspaces"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) | Obtain information about WorkSpaces | List | 
| <a name="workspaces-DescribeWorkspacesConnectionStatus"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesConnectionStatus.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesConnectionStatus.html) | Obtain the connection status of WorkSpaces | Read | 
| <a name="workspaces-DescribeWorkspacesPoolSessions"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesPoolSessions.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesPoolSessions.html) | Retrieve information about the sessions of a WorkSpaces Pool | List | 
| <a name="workspaces-DescribeWorkspacesPools"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesPools.html](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspacesPools.html) | Retrieve information about WorkSpaces Pools | List | 
| <a name="workspaces-DirectoryAccessManagement"></a>[https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-console-permissions-ref.html](https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-console-permissions-ref.html) | Directory management actions while managing and provisioning workspaces | List | 
| <a name="workspaces-GetAccountLink"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_GetAccountLink.html](https://docs.aws.amazon.com/workspaces/latest/api/API_GetAccountLink.html) | Retrieve a link with another AWS Account for sharing configuration for WorkSpaces BYOL | Read | 
| <a name="workspaces-GetTroubleshootingRecommendation"></a>[https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html) | Get troubleshooting recommendations | Read | 
| <a name="workspaces-InvokeTroubleshootingInvestigation"></a>[https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html) | Invoke troubleshooting investigation | Read | 
| <a name="workspaces-ListAccountLinks"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_ListAccountLinks.html](https://docs.aws.amazon.com/workspaces/latest/api/API_ListAccountLinks.html) | Retrieve links with the AWS Account(s) that share your configuration for WorkSpaces BYOL | List | 
| <a name="workspaces-ListAvailableManagementCidrRanges"></a>[https://docs.aws.amazon.com/workspaces/latest/api/API_ListAvailableManagementCidrRanges.html](https://docs.aws.amazon.com/workspaces/latest/api/API_ListAvailableManagementCidrRanges.html) | List the available CIDR ranges for enabling Bring Your Own License (BYOL) for WorkSpaces accounts | List | 
| <a name="workspaces-ListTroubleshootingRecommendations"></a>[https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-advisor.html) | List troubleshooting recommendations | Read |