ListAssociatedFleetsCommand

Suggest an Edit

Retrieves the name of the fleet that is associated with the specified stack.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppStreamClient, ListAssociatedFleetsCommand } from "@aws-sdk/client-appstream"; // ES Modules import
// const { AppStreamClient, ListAssociatedFleetsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import
const client = new AppStreamClient(config);
const input = { // ListAssociatedFleetsRequest
  StackName: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
};
const command = new ListAssociatedFleetsCommand(input);
const response = await client.send(command);
// { // ListAssociatedFleetsResult
//   Names: [ // StringList
//     "STRING_VALUE",
//   ],
//   NextToken: "STRING_VALUE",
// };

ListAssociatedFleetsCommand Input

See ListAssociatedFleetsCommandInput for more details

Parameter
Type
Description
StackName
Required
string | undefined

The name of the stack.

NextToken
string | undefined

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

ListAssociatedFleetsCommand Output

See ListAssociatedFleetsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Names
string[] | undefined

The name of the fleet.

NextToken
string | undefined

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Throws

Name
Fault
Details
AppStreamServiceException
Base exception class for all service exceptions from AppStream service.