ListOutpostsWithS3Command

Suggest an Edit

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).

Example Syntax

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

import { S3OutpostsClient, ListOutpostsWithS3Command } from "@aws-sdk/client-s3outposts"; // ES Modules import
// const { S3OutpostsClient, ListOutpostsWithS3Command } = require("@aws-sdk/client-s3outposts"); // CommonJS import
const client = new S3OutpostsClient(config);
const input = { // ListOutpostsWithS3Request
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListOutpostsWithS3Command(input);
const response = await client.send(command);
// { // ListOutpostsWithS3Result
//   Outposts: [ // Outposts
//     { // Outpost
//       OutpostArn: "STRING_VALUE",
//       S3OutpostArn: "STRING_VALUE",
//       OutpostId: "STRING_VALUE",
//       OwnerId: "STRING_VALUE",
//       CapacityInBytes: Number("long"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListOutpostsWithS3Command Input

See ListOutpostsWithS3CommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of Outposts to return. The limit is 100.

NextToken
string | undefined

When you can get additional results from the ListOutpostsWithS3 call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional Outposts.

ListOutpostsWithS3Command Output

See ListOutpostsWithS3CommandOutput for details

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

Returns a token that you can use to call ListOutpostsWithS3 again and receive additional results, if there are any.

Outposts
Outpost[] | undefined

Returns the list of Outposts that have the following characteristics:

  • outposts that have S3 provisioned

  • outposts that are Active (not pending any provisioning nor decommissioned)

  • outposts to which the the calling Amazon Web Services account has access

Throws

Name
Fault
Details
AccessDeniedException
client

Access was denied for this action.

InternalServerException
server

There was an exception with the internal server.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

There was an exception validating this data.

S3OutpostsServiceException
Base exception class for all service exceptions from S3Outposts service.