DescribeAccountModiﬁcations

Retrieves a list that describes modiﬁcations to the conﬁguration of Bring Your Own License (BYOL) for the speciﬁed account.

Request Syntax

{

"NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

NextToken (p. 51)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{ "AccountModifications": [ {

"DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string",

"ErrorCode": "string",

"NextToken": "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.

AccountModiﬁcations (p. 51)

The list of modiﬁcations to the conﬁguration of BYOL.

Amazon WorkSpaces Service API Reference Errors

NextToken (p. 51)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

Request Syntax

{ "ResourceIds": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

ResourceIds (p. 53)

The resource identiﬁer, in the form of directory IDs.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{ "ClientPropertiesList": [ {

"ClientProperties": {

"ReconnectEnabled": "string"

"ResourceId": "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.

ClientPropertiesList (p. 53)

Information about the speciﬁed Amazon WorkSpaces clients.

Type: Array of ClientPropertiesResult (p. 148) objects

Errors

Amazon WorkSpaces Service API Reference See Also

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ResourceId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

MaxResults (p. 55)

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 55)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No ResourceId (p. 55)

The directory identiﬁer for which the client add-in is conﬁgured.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: Yes

Response Syntax

{

"AddIns": [ {

Amazon WorkSpaces Service API Reference Response Elements

"URL": "string"

} ],

"NextToken": "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.

AddIns (p. 55)

Information about client add-ins.

Type: Array of ConnectClientAddIn (p. 150) objects NextToken (p. 55)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

DescribeConnectionAliases

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Request Syntax

{

"AliasIds": [ "string" ], "Limit": number,

"NextToken": "string", "ResourceId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

AliasIds (p. 58)

The identiﬁers of the connection aliases to describe.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: No Limit (p. 58)

The maximum number of connection aliases to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 58)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No ResourceId (p. 58)

The identiﬁer of the directory associated with the connection alias.

Type: String

API Version 2015-04-08 58

Response Syntax

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "ConnectionAliases": [ {

"NextToken": "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.

ConnectionAliases (p. 59)

Information about the speciﬁed connection aliases.

Type: Array of ConnectionAlias (p. 152) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

NextToken (p. 59)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

Amazon WorkSpaces Service API Reference See Also

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400

Request Syntax

{

"AliasId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

AliasId (p. 61)

The identiﬁer of the connection alias.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: Yes MaxResults (p. 61)

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 61)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{

Amazon WorkSpaces Service API Reference

"NextToken": "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.

AliasId (p. 61)

The identiﬁer of the connection alias.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

ConnectionAliasPermissions (p. 61)

The permissions associated with a connection alias.

Type: Array of ConnectionAliasPermission (p. 156) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

NextToken (p. 61)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

OperationNotSupportedException This operation is not supported.

HTTP Status Code: 400

API Version 2015-04-08 62

DescribeIpGroups

Describes one or more of your IP access control groups.

Request Syntax

{ "GroupIds": [ "string" ], "MaxResults": number, "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

GroupIds (p. 64)

The identiﬁers of one or more IP access control groups.

Type: Array of strings

Pattern: wsipg-[0-9a-z]{8,63}$

Required: No MaxResults (p. 64)

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 64)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{ "NextToken": "string", "Result": [

API Version 2015-04-08 64

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.

NextToken (p. 64)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Result (p. 64)

Information about the IP access control groups.

Type: Array of WorkspacesIpGroup (p. 196) objects

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

Request Syntax

{

"ResourceId": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ResourceId (p. 67)

The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{

"TagList": [ {

"Key": "string", "Value": "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.

TagList (p. 67) The tags.

Type: Array of Tag (p. 173) objects

Errors

Amazon WorkSpaces Service API Reference See Also

ResourceNotFoundException The resource could not be found.

HTTP Status Code: 400

Request Syntax

{

"BundleIds": [ "string" ], "NextToken": "string", "Owner": "string"

}

Request Parameters

The request accepts the following data in JSON format.

BundleIds (p. 69)

The identiﬁers of the bundles. You cannot combine this parameter with any other ﬁlter.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: No NextToken (p. 69)

The token for the next set of results. (You received this token from a previous call.) Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No Owner (p. 69)

The owner of the bundles. You cannot combine this parameter with any other ﬁlter.

To describe the bundles provided by AWS, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.

Type: String Required: No

Response Syntax

{

Amazon WorkSpaces Service API Reference

"NextToken": "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.

Bundles (p. 69)

Information about the bundles.

Type: Array of WorkspaceBundle (p. 182) objects NextToken (p. 69)

The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

DescribeWorkspaceDirectories

Describes the available directories that are registered with Amazon WorkSpaces.

Request Syntax

{ "DirectoryIds": [ "string" ], "Limit": number,

"NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

DirectoryIds (p. 72)

The identiﬁers of the directories. If the value is null, all directories are retrieved.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: No Limit (p. 72)

The maximum number of directories to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 72)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{

"Directories": [ {

API Version 2015-04-08 72

Response Elements

"UserEnabledAsLocalAdministrator": boolean },

"WorkspaceSecurityGroupId": "string"

} ],

"NextToken": "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.

Directories (p. 72)

Information about the directories.

Type: Array of WorkspaceDirectory (p. 187) objects NextToken (p. 72)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Amazon WorkSpaces Service API Reference Errors

Errors

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

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

Request Syntax

{

"ImageId": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ImageId (p. 75)

The identiﬁer of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes MaxResults (p. 75)

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 75)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{

"ImageId": "string", "ImagePermissions": [ {

"SharedAccountId": "string"

Amazon WorkSpaces Service API Reference Response Elements

}

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.

ImageId (p. 75)

The identiﬁer of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

ImagePermissions (p. 75)

The identiﬁers of the AWS accounts that the image has been shared with.

Type: Array of ImagePermission (p. 161) objects NextToken (p. 75)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400 InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400 ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

DescribeWorkspaceImages

Retrieves a list that describes one or more speciﬁed images, if the image identiﬁers are provided.

Otherwise, all images in the account are described.

Request Syntax

{

"ImageIds": [ "string" ], "ImageType": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

The request accepts the following data in JSON format.

ImageIds (p. 78)

The identiﬁer of the image.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Pattern: wsi-[0-9a-z]{9,63}$

Required: No ImageType (p. 78)

The type (owned or shared) of the image.

Type: String

Valid Values: OWNED | SHARED Required: No

MaxResults (p. 78)

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No NextToken (p. 78)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

API Version 2015-04-08 78

Response Syntax

"NextToken": "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.

Images (p. 79)

Information about the images.

Type: Array of WorkspaceImage (p. 190) objects NextToken (p. 79)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

AccessDeniedException

Amazon WorkSpaces Service API Reference See Also

DescribeAccountModiﬁcations