GetOutpostCommand

Suggest an Edit

Gets information about the specified Outpost.

Example Syntax

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

import { OutpostsClient, GetOutpostCommand } from "@aws-sdk/client-outposts"; // ES Modules import
// const { OutpostsClient, GetOutpostCommand } = require("@aws-sdk/client-outposts"); // CommonJS import
const client = new OutpostsClient(config);
const input = { // GetOutpostInput
  OutpostId: "STRING_VALUE", // required
};
const command = new GetOutpostCommand(input);
const response = await client.send(command);
// { // GetOutpostOutput
//   Outpost: { // Outpost
//     OutpostId: "STRING_VALUE",
//     OwnerId: "STRING_VALUE",
//     OutpostArn: "STRING_VALUE",
//     SiteId: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     LifeCycleStatus: "STRING_VALUE",
//     AvailabilityZone: "STRING_VALUE",
//     AvailabilityZoneId: "STRING_VALUE",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     SiteArn: "STRING_VALUE",
//     SupportedHardwareType: "RACK" || "SERVER",
//   },
// };

GetOutpostCommand Input

See GetOutpostCommandInput for more details

Parameter
Type
Description
OutpostId
Required
string | undefined

The ID or ARN of the Outpost.

GetOutpostCommand Output

See GetOutpostCommandOutput for details

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

Information about an Outpost.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have permission to perform this operation.

InternalServerException
server

An internal error has occurred.

NotFoundException
client

The specified request is not valid.

ValidationException
client

A parameter is not valid.

OutpostsServiceException
Base exception class for all service exceptions from Outposts service.