Data retrieval APIs for Amazon WorkSpaces - AWS Online Register of Data Formats

Data retrieval APIs for Amazon WorkSpaces

Amazon WorkSpaces provides the following APIs for data retrieval.

Actions Description Access level
DescribeAccountRetrieve the configuration of Bring Your Own License (BYOL) for WorkSpaces accountsRead
DescribeAccountModificationsRetrieve modifications to the configuration of Bring Your Own License (BYOL) for WorkSpaces accountsRead
DescribeApplicationAssociationsRetrieve information about resources associated with a WorkSpace applicationList
DescribeApplicationsObtain information about WorkSpace applicationsList
DescribeBundleAssociationsRetrieve information about resources associated with a WorkSpace bundleList
DescribeClientBrandingRetrieve AWS WorkSpaces Client branding data within a directoryRead
DescribeClientPropertiesRetrieve information about WorkSpaces clientsList
DescribeConnectClientAddInsRetrieve a list of Amazon Connect client add-ins that have been createdList
DescribeConnectionAliasPermissionsRetrieve the permissions that the owners of connection aliases have granted to other AWS accounts for connection aliasesRead
DescribeConnectionAliasesRetrieve a list that describes the connection aliases used for cross-Region redirectionRead
DescribeConsentRetrieve information about consent agreement to BYOL minimum requirementsRead
DescribeCustomWorkspaceImageImportRetrieve information about WorkSpace BYOL image import taskRead
DescribeImageAssociationsRetrieve information about resources associated with a WorkSpace imageList
DescribeIpGroupsRetrieve information about IP access control groupsRead
DescribeRootClientCertificatesRetrieve information for root client certificatesList
DescribeTagsDescribe the tags for WorkSpaces resourcesRead
DescribeWorkspaceAssociationsRetrieve information about resources associated with a WorkSpaceList
DescribeWorkspaceBundlesObtain information about WorkSpace bundlesList
DescribeWorkspaceDirectoriesRetrieve information about directories that are registered with WorkSpacesRead
DescribeWorkspaceImagePermissionsRetrieve information about WorkSpace image permissionsRead
DescribeWorkspaceImagesRetrieve information about WorkSpace imagesList
DescribeWorkspaceSnapshotsRetrieve information about WorkSpace snapshotsList
DescribeWorkspacesObtain information about WorkSpacesList
DescribeWorkspacesConnectionStatusObtain the connection status of WorkSpacesRead
DescribeWorkspacesPoolSessionsRetrieve information about the sessions of a WorkSpaces PoolList
DescribeWorkspacesPoolsRetrieve information about WorkSpaces PoolsList
DirectoryAccessManagementDirectory management actions while managing and provisioning workspacesList
Retrieve a link with another AWS Account for sharing configuration for WorkSpaces BYOLRead
Retrieve links with the AWS Account(s) that share your configuration for WorkSpaces BYOLList
ListAvailableManagementCidrRangesList the available CIDR ranges for enabling Bring Your Own License (BYOL) for WorkSpaces accountsList