@aws-sdk/client-outposts 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { OutpostsServiceException as __BaseException } from "./OutpostsServiceException";
 /**
+ * @public
  * <p>You do not have permission to perform this operation.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p> Information about an address. </p>
  */
 export interface Address {
@@ -61,11 +63,15 @@ export interface Address {
      */
     Municipality?: string;
 }
+/**
+ * @public
+ */
 export declare enum AddressType {
     OPERATING_ADDRESS = "OPERATING_ADDRESS",
     SHIPPING_ADDRESS = "SHIPPING_ADDRESS"
 }
 /**
+ * @public
  * <p> Information about the position of the asset in a rack. </p>
  */
 export interface AssetLocation {
@@ -74,15 +80,22 @@ export interface AssetLocation {
      */
     RackElevation?: number;
 }
+/**
+ * @public
+ */
 export declare enum AssetType {
     COMPUTE = "COMPUTE"
 }
+/**
+ * @public
+ */
 export declare enum ComputeAssetState {
     ACTIVE = "ACTIVE",
     ISOLATED = "ISOLATED",
     RETIRING = "RETIRING"
 }
 /**
+ * @public
  * <p> Information about compute hardware assets. </p>
  */
 export interface ComputeAttributes {
@@ -111,6 +124,7 @@ export interface ComputeAttributes {
     State?: ComputeAssetState | string;
 }
 /**
+ * @public
  * <p> Information about hardware assets. </p>
  */
 export interface AssetInfo {
@@ -135,23 +149,36 @@ export interface AssetInfo {
      */
     AssetLocation?: AssetLocation;
 }
+/**
+ * @public
+ */
 export declare enum AssetState {
     ACTIVE = "ACTIVE",
     RETIRING = "RETIRING"
 }
+/**
+ * @public
+ */
 export interface CancelOrderInput {
     /**
      * <p> The ID of the order. </p>
      */
     OrderId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CancelOrderOutput {
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     ORDER = "ORDER",
     OUTPOST = "OUTPOST"
 }
 /**
+ * @public
  * <p>Updating or deleting this resource can cause an inconsistent state.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -172,6 +199,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>An internal error has occurred.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -184,6 +212,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified request is not valid.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -196,6 +225,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>A parameter is not valid.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -208,6 +238,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p> Information about EC2 capacity. </p>
  */
 export interface EC2Capacity {
@@ -224,15 +255,22 @@ export interface EC2Capacity {
      */
     Quantity?: string;
 }
+/**
+ * @public
+ */
 export declare enum CatalogItemStatus {
     AVAILABLE = "AVAILABLE",
     DISCONTINUED = "DISCONTINUED"
 }
+/**
+ * @public
+ */
 export declare enum SupportedStorageEnum {
     EBS = "EBS",
     S3 = "S3"
 }
 /**
+ * @public
  * <p> Information about a catalog item. </p>
  */
 export interface CatalogItem {
@@ -265,11 +303,15 @@ export interface CatalogItem {
      */
     SupportedStorage?: (SupportedStorageEnum | string)[];
 }
+/**
+ * @public
+ */
 export declare enum CatalogItemClass {
     RACK = "RACK",
     SERVER = "SERVER"
 }
 /**
+ * @public
  * <p> Information about a connection. </p>
  */
 export interface ConnectionDetails {
@@ -299,6 +341,7 @@ export interface ConnectionDetails {
     AllowedIps?: string[];
 }
 /**
+ * @public
  * <p>Information about a line item request.</p>
  */
 export interface LineItemRequest {
@@ -311,15 +354,24 @@ export interface LineItemRequest {
      */
     Quantity?: number;
 }
+/**
+ * @public
+ */
 export declare enum PaymentOption {
     ALL_UPFRONT = "ALL_UPFRONT",
     NO_UPFRONT = "NO_UPFRONT",
     PARTIAL_UPFRONT = "PARTIAL_UPFRONT"
 }
+/**
+ * @public
+ */
 export declare enum PaymentTerm {
     ONE_YEAR = "ONE_YEAR",
     THREE_YEARS = "THREE_YEARS"
 }
+/**
+ * @public
+ */
 export interface CreateOrderInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
@@ -339,6 +391,7 @@ export interface CreateOrderInput {
     PaymentTerm?: PaymentTerm | string;
 }
 /**
+ * @public
  * <p> Information about a line item asset. </p>
  */
 export interface LineItemAssetInformation {
@@ -351,6 +404,9 @@ export interface LineItemAssetInformation {
      */
     MacAddressList?: string[];
 }
+/**
+ * @public
+ */
 export declare enum ShipmentCarrier {
     DBS = "DBS",
     DHL = "DHL",
@@ -358,6 +414,7 @@ export declare enum ShipmentCarrier {
     UPS = "UPS"
 }
 /**
+ * @public
  * <p> Information about a line item shipment. </p>
  */
 export interface ShipmentInformation {
@@ -370,6 +427,9 @@ export interface ShipmentInformation {
      */
     ShipmentCarrier?: ShipmentCarrier | string;
 }
+/**
+ * @public
+ */
 export declare enum LineItemStatus {
     BUILDING = "BUILDING",
     CANCELLED = "CANCELLED",
@@ -382,6 +442,7 @@ export declare enum LineItemStatus {
     SHIPPED = "SHIPPED"
 }
 /**
+ * @public
  * <p>Information about a line item.</p>
  */
 export interface LineItem {
@@ -418,10 +479,16 @@ export interface LineItem {
      */
     PreviousOrderId?: string;
 }
+/**
+ * @public
+ */
 export declare enum OrderType {
     OUTPOST = "OUTPOST",
     REPLACEMENT = "REPLACEMENT"
 }
+/**
+ * @public
+ */
 export declare enum OrderStatus {
     CANCELLED = "CANCELLED",
     COMPLETED = "COMPLETED",
@@ -435,6 +502,7 @@ export declare enum OrderStatus {
     RECEIVED = "RECEIVED"
 }
 /**
+ * @public
  * <p>Information about an order.</p>
  */
 export interface Order {
@@ -502,6 +570,9 @@ export interface Order {
      */
     OrderType?: OrderType | string;
 }
+/**
+ * @public
+ */
 export interface CreateOrderOutput {
     /**
      * <p>Information about this order.</p>
@@ -509,6 +580,7 @@ export interface CreateOrderOutput {
     Order?: Order;
 }
 /**
+ * @public
  * <p>You have exceeded a service quota.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -520,10 +592,16 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum SupportedHardwareType {
     RACK = "RACK",
     SERVER = "SERVER"
 }
+/**
+ * @public
+ */
 export interface CreateOutpostInput {
     /**
      * <p>The name of the Outpost.</p>
@@ -555,6 +633,7 @@ export interface CreateOutpostInput {
     SupportedHardwareType?: SupportedHardwareType | string;
 }
 /**
+ * @public
  * <p>Information about an Outpost.</p>
  */
 export interface Outpost {
@@ -607,16 +686,25 @@ export interface Outpost {
      */
     SupportedHardwareType?: SupportedHardwareType | string;
 }
+/**
+ * @public
+ */
 export interface CreateOutpostOutput {
     /**
      * <p>Information about an Outpost.</p>
      */
     Outpost?: Outpost;
 }
+/**
+ * @public
+ */
 export declare enum FiberOpticCableType {
     MULTI_MODE = "MULTI_MODE",
     SINGLE_MODE = "SINGLE_MODE"
 }
+/**
+ * @public
+ */
 export declare enum MaximumSupportedWeightLbs {
     MAX_1400_LBS = "MAX_1400_LBS",
     MAX_1600_LBS = "MAX_1600_LBS",
@@ -624,6 +712,9 @@ export declare enum MaximumSupportedWeightLbs {
     MAX_2000_LBS = "MAX_2000_LBS",
     NO_LIMIT = "NO_LIMIT"
 }
+/**
+ * @public
+ */
 export declare enum OpticalStandard {
     OPTIC_1000BASE_LX = "OPTIC_1000BASE_LX",
     OPTIC_1000BASE_SX = "OPTIC_1000BASE_SX",
@@ -639,26 +730,41 @@ export declare enum OpticalStandard {
     OPTIC_40GBASE_LR4 = "OPTIC_40GBASE_LR4",
     OPTIC_40GBASE_SR = "OPTIC_40GBASE_SR"
 }
+/**
+ * @public
+ */
 export declare enum PowerConnector {
     AH530P7W = "AH530P7W",
     AH532P6W = "AH532P6W",
     IEC309 = "IEC309",
     L6_30P = "L6_30P"
 }
+/**
+ * @public
+ */
 export declare enum PowerDrawKva {
     POWER_10_KVA = "POWER_10_KVA",
     POWER_15_KVA = "POWER_15_KVA",
     POWER_30_KVA = "POWER_30_KVA",
     POWER_5_KVA = "POWER_5_KVA"
 }
+/**
+ * @public
+ */
 export declare enum PowerFeedDrop {
     ABOVE_RACK = "ABOVE_RACK",
     BELOW_RACK = "BELOW_RACK"
 }
+/**
+ * @public
+ */
 export declare enum PowerPhase {
     SINGLE_PHASE = "SINGLE_PHASE",
     THREE_PHASE = "THREE_PHASE"
 }
+/**
+ * @public
+ */
 export declare enum UplinkCount {
     UPLINK_COUNT_1 = "UPLINK_COUNT_1",
     UPLINK_COUNT_12 = "UPLINK_COUNT_12",
@@ -671,6 +777,9 @@ export declare enum UplinkCount {
     UPLINK_COUNT_7 = "UPLINK_COUNT_7",
     UPLINK_COUNT_8 = "UPLINK_COUNT_8"
 }
+/**
+ * @public
+ */
 export declare enum UplinkGbps {
     UPLINK_100G = "UPLINK_100G",
     UPLINK_10G = "UPLINK_10G",
@@ -678,6 +787,7 @@ export declare enum UplinkGbps {
     UPLINK_40G = "UPLINK_40G"
 }
 /**
+ * @public
  * <p> Information about the physical and logistical details for racks at sites.
  *       For more information
  *       about hardware requirements for racks, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist">Network
@@ -728,6 +838,9 @@ export interface RackPhysicalProperties {
      */
     MaximumSupportedWeightLbs?: MaximumSupportedWeightLbs | string;
 }
+/**
+ * @public
+ */
 export interface CreateSiteInput {
     /**
      * <p>The name of the site.</p>
@@ -767,6 +880,7 @@ export interface CreateSiteInput {
     RackPhysicalProperties?: RackPhysicalProperties;
 }
 /**
+ * @public
  * <p>Information about a site.</p>
  */
 export interface Site {
@@ -816,46 +930,73 @@ export interface Site {
      */
     RackPhysicalProperties?: RackPhysicalProperties;
 }
+/**
+ * @public
+ */
 export interface CreateSiteOutput {
     /**
      * <p>Information about a site.</p>
      */
     Site?: Site;
 }
+/**
+ * @public
+ */
 export interface DeleteOutpostInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
      */
     OutpostId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteOutpostOutput {
 }
+/**
+ * @public
+ */
 export interface DeleteSiteInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
      */
     SiteId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteSiteOutput {
 }
+/**
+ * @public
+ */
 export interface GetCatalogItemInput {
     /**
      * <p>The ID of the catalog item.</p>
      */
     CatalogItemId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetCatalogItemOutput {
     /**
      * <p>Information about this catalog item.</p>
      */
     CatalogItem?: CatalogItem;
 }
+/**
+ * @public
+ */
 export interface GetConnectionRequest {
     /**
      * <p> The ID of the connection. </p>
      */
     ConnectionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetConnectionResponse {
     /**
      * <p> The ID of the connection. </p>
@@ -866,30 +1007,45 @@ export interface GetConnectionResponse {
      */
     ConnectionDetails?: ConnectionDetails;
 }
+/**
+ * @public
+ */
 export interface GetOrderInput {
     /**
      * <p>The ID of the order.</p>
      */
     OrderId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetOrderOutput {
     /**
      * <p>Information about an order.</p>
      */
     Order?: Order;
 }
+/**
+ * @public
+ */
 export interface GetOutpostInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
      */
     OutpostId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetOutpostOutput {
     /**
      * <p>Information about an Outpost.</p>
      */
     Outpost?: Outpost;
 }
+/**
+ * @public
+ */
 export interface GetOutpostInstanceTypesInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
@@ -905,6 +1061,7 @@ export interface GetOutpostInstanceTypesInput {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>Information about an instance type.</p>
  */
 export interface InstanceTypeItem {
@@ -913,6 +1070,9 @@ export interface InstanceTypeItem {
      */
     InstanceType?: string;
 }
+/**
+ * @public
+ */
 export interface GetOutpostInstanceTypesOutput {
     /**
      * <p>Information about the instance types.</p>
@@ -931,18 +1091,27 @@ export interface GetOutpostInstanceTypesOutput {
      */
     OutpostArn?: string;
 }
+/**
+ * @public
+ */
 export interface GetSiteInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
      */
     SiteId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSiteOutput {
     /**
      * <p>Information about a site.</p>
      */
     Site?: Site;
 }
+/**
+ * @public
+ */
 export interface GetSiteAddressInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
@@ -953,6 +1122,9 @@ export interface GetSiteAddressInput {
      */
     AddressType: AddressType | string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetSiteAddressOutput {
     /**
      * <p>The ID of the site.</p>
@@ -967,6 +1139,9 @@ export interface GetSiteAddressOutput {
      */
     Address?: Address;
 }
+/**
+ * @public
+ */
 export interface ListAssetsInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
@@ -989,6 +1164,9 @@ export interface ListAssetsInput {
      */
     StatusFilter?: (AssetState | string)[];
 }
+/**
+ * @public
+ */
 export interface ListAssetsOutput {
     /**
      * <p>Information about the hardware assets.</p>
@@ -999,6 +1177,9 @@ export interface ListAssetsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListCatalogItemsInput {
     /**
      * <p>The pagination token.</p>
@@ -1021,6 +1202,9 @@ export interface ListCatalogItemsInput {
      */
     EC2FamilyFilter?: string[];
 }
+/**
+ * @public
+ */
 export interface ListCatalogItemsOutput {
     /**
      * <p>Information about the catalog items.</p>
@@ -1031,6 +1215,9 @@ export interface ListCatalogItemsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListOrdersInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
@@ -1046,6 +1233,7 @@ export interface ListOrdersInput {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p> A summary of line items in your order. </p>
  */
 export interface OrderSummary {
@@ -1105,6 +1293,9 @@ export interface OrderSummary {
      */
     OrderFulfilledDate?: Date;
 }
+/**
+ * @public
+ */
 export interface ListOrdersOutput {
     /**
      * <p> Information about the orders. </p>
@@ -1115,6 +1306,9 @@ export interface ListOrdersOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListOutpostsInput {
     /**
      * <p>The pagination token.</p>
@@ -1137,6 +1331,9 @@ export interface ListOutpostsInput {
      */
     AvailabilityZoneIdFilter?: string[];
 }
+/**
+ * @public
+ */
 export interface ListOutpostsOutput {
     /**
      * <p>Information about the Outposts.</p>
@@ -1147,6 +1344,9 @@ export interface ListOutpostsOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSitesInput {
     /**
      * <p>The pagination token.</p>
@@ -1169,6 +1369,9 @@ export interface ListSitesInput {
      */
     OperatingAddressCityFilter?: string[];
 }
+/**
+ * @public
+ */
 export interface ListSitesOutput {
     /**
      * <p>Information about the sites.</p>
@@ -1179,18 +1382,27 @@ export interface ListSitesOutput {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The resource tags.</p>
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface StartConnectionRequest {
     /**
      * <p> The serial number of the dongle. </p>
@@ -1209,6 +1421,9 @@ export interface StartConnectionRequest {
      */
     NetworkInterfaceDeviceIndex: number | undefined;
 }
+/**
+ * @public
+ */
 export interface StartConnectionResponse {
     /**
      * <p> The ID of the connection. </p>
@@ -1219,6 +1434,9 @@ export interface StartConnectionResponse {
      */
     UnderlayIpAddress?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
@@ -1229,8 +1447,14 @@ export interface TagResourceRequest {
      */
     Tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
@@ -1241,8 +1465,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateOutpostInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the Outpost. </p>
@@ -1261,12 +1491,18 @@ export interface UpdateOutpostInput {
      */
     SupportedHardwareType?: SupportedHardwareType | string;
 }
+/**
+ * @public
+ */
 export interface UpdateOutpostOutput {
     /**
      * <p>Information about an Outpost.</p>
      */
     Outpost?: Outpost;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
@@ -1285,12 +1521,18 @@ export interface UpdateSiteInput {
      */
     Notes?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteOutput {
     /**
      * <p>Information about a site.</p>
      */
     Site?: Site;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteAddressInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
@@ -1305,6 +1547,9 @@ export interface UpdateSiteAddressInput {
      */
     Address: Address | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteAddressOutput {
     /**
      * <p> The type of the address. </p>
@@ -1315,6 +1560,9 @@ export interface UpdateSiteAddressOutput {
      */
     Address?: Address;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteRackPhysicalPropertiesInput {
     /**
      * <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
@@ -1471,6 +1719,9 @@ export interface UpdateSiteRackPhysicalPropertiesInput {
      */
     MaximumSupportedWeightLbs?: MaximumSupportedWeightLbs | string;
 }
+/**
+ * @public
+ */
 export interface UpdateSiteRackPhysicalPropertiesOutput {
     /**
      * <p>Information about a site.</p>