DescribeApplicationFleetAssociations - Amazon AppStream 2.0

DescribeApplicationFleetAssociations

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

Request Syntax

{ "ApplicationArn": "string", "FleetName": "string", "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationArn

The ARN of the application.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: No

FleetName

The name of the fleet.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: No

MaxResults

The maximum size of each page of results.

Type: Integer

Required: No

NextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "ApplicationFleetAssociations": [ { "ApplicationArn": "string", "FleetName": "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.

ApplicationFleetAssociations

The application fleet associations in the list.

Type: Array of ApplicationFleetAssociation objects

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

NextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

See Also

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