DescribeApplicationAssociations - Amazon WorkSpaces Service

DescribeApplicationAssociations

Describes the associations between the application and the specified associated resources.

Request Syntax

{ "ApplicationId": "string", "AssociatedResourceTypes": [ "string" ], "MaxResults": number, "NextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

ApplicationId

The identifier of the specified application.

Type: String

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

Required: Yes

AssociatedResourceTypes

The resource type of the associated resources.

Type: Array of strings

Valid Values: WORKSPACE | BUNDLE | IMAGE

Required: Yes

MaxResults

The maximum number of associations 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

Response Syntax

{ "Associations": [ { "ApplicationId": "string", "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "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.

Associations

List of associations and information about them.

Type: Array of ApplicationResourceAssociation 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.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

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