DescribeAccount - Amazon WorkSpaces Service

DescribeAccount

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Response Syntax

{ "DedicatedTenancyAccountType": "string", "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DedicatedTenancyAccountType

The type of linked account.

Type: String

Valid Values: SOURCE_ACCOUNT | TARGET_ACCOUNT

DedicatedTenancyManagementCidrRange

The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

Type: String

Pattern: (^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$

DedicatedTenancySupport

The status of BYOL (whether BYOL is enabled or disabled).

Type: String

Valid Values: ENABLED | DISABLED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: