Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeApplications

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Request Syntax


{
   "ApplicationIds": [ "string" ],
   "ComputeTypeNames": [ "string" ],
   "LicenseType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "OperatingSystemNames": [ "string" ],
   "Owner": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ApplicationIds

The identifiers of one or more applications.

Type: Array of strings

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

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

Required: No

ComputeTypeNames

The compute types supported by the applications.

Type: Array of strings

Required: No

LicenseType

The license availability for the applications.

Type: String

Valid Values: LICENSED | UNLICENSED

Required: No

MaxResults

The maximum number of applications to return.

Type: Integer

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

Required: No

NextToken

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

OperatingSystemNames

The operating systems supported by the applications.

Type: Array of strings

Required: No

Owner

The owner of the applications.

Type: String

Pattern: ^\d{12}|AMAZON$

Required: No

Response Syntax


{
   "Applications": [ 
      { 
         "ApplicationId": "string",
         "Created": number,
         "Description": "string",
         "LicenseType": "string",
         "Name": "string",
         "Owner": "string",
         "State": "string",
         "SupportedComputeTypeNames": [ "string" ],
         "SupportedOperatingSystemNames": [ "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.

Applications

List of information about the specified applications.

Type: Array of WorkSpaceApplication objects

NextToken

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.

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

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

message: The exception error message.
reason: The exception error reason.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

message: The resource could not be found.
ResourceId: The ID of the resource that could not be found.

HTTP Status Code: 400