ListExtensibleSourceServersCommand

Suggest an Edit

Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.

Example Syntax

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

import { DrsClient, ListExtensibleSourceServersCommand } from "@aws-sdk/client-drs"; // ES Modules import
// const { DrsClient, ListExtensibleSourceServersCommand } = require("@aws-sdk/client-drs"); // CommonJS import
const client = new DrsClient(config);
const input = { // ListExtensibleSourceServersRequest
  stagingAccountID: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListExtensibleSourceServersCommand(input);
const response = await client.send(command);
// { // ListExtensibleSourceServersResponse
//   items: [ // StagingSourceServersList
//     { // StagingSourceServer
//       hostname: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       tags: { // TagsMap
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListExtensibleSourceServersCommand Input

See ListExtensibleSourceServersCommandInput for more details

Parameter
Type
Description
stagingAccountID
Required
string | undefined

The Id of the staging Account to retrieve extensible source servers from.

maxResults
number | undefined

The maximum number of extensible source servers to retrieve.

nextToken
string | undefined

The token of the next extensible source server to retrieve.

ListExtensibleSourceServersCommand Output

See ListExtensibleSourceServersCommandOutput for details

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

A list of source servers on a staging Account that are extensible.

nextToken
string | undefined

The token of the next extensible source server to retrieve.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ThrottlingException
client

The request was denied due to request throttling.

UninitializedAccountException
client

The account performing the request has not been initialized.

ValidationException
client

The input fails to satisfy the constraints specified by the AWS service.

DrsServiceException
Base exception class for all service exceptions from Drs service.