{ "version":"2.0", "metadata":{ "apiVersion":"2019-12-03", "endpointPrefix":"outposts", "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceAbbreviation":"Outposts", "serviceFullName":"AWS Outposts", "serviceId":"Outposts", "signatureVersion":"v4", "signingName":"outposts", "uid":"outposts-2019-12-03", "auth":["aws.auth#sigv4"] }, "operations":{ "CancelCapacityTask":{ "name":"CancelCapacityTask", "http":{ "method":"POST", "requestUri":"/outposts/{OutpostId}/capacity/{CapacityTaskId}" }, "input":{"shape":"CancelCapacityTaskInput"}, "output":{"shape":"CancelCapacityTaskOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], "documentation":"
Cancels the capacity task.
" }, "CancelOrder":{ "name":"CancelOrder", "http":{ "method":"POST", "requestUri":"/orders/{OrderId}/cancel" }, "input":{"shape":"CancelOrderInput"}, "output":{"shape":"CancelOrderOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Cancels the specified order for an Outpost.
" }, "CreateOrder":{ "name":"CreateOrder", "http":{ "method":"POST", "requestUri":"/orders" }, "input":{"shape":"CreateOrderInput"}, "output":{"shape":"CreateOrderOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates an order for an Outpost.
" }, "CreateOutpost":{ "name":"CreateOutpost", "http":{ "method":"POST", "requestUri":"/outposts" }, "input":{"shape":"CreateOutpostInput"}, "output":{"shape":"CreateOutpostOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates an Outpost.
You can specify either an Availability one or an AZ ID.
" }, "CreateQuote":{ "name":"CreateQuote", "http":{ "method":"POST", "requestUri":"/quotes" }, "input":{"shape":"CreateQuoteInput"}, "output":{"shape":"CreateQuoteOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"NotFoundException"} ], "documentation":"Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.
" }, "CreateRenewal":{ "name":"CreateRenewal", "http":{ "method":"POST", "requestUri":"/renewals" }, "input":{"shape":"CreateRenewalInput"}, "output":{"shape":"CreateRenewalOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"NotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Creates a renewal contract for the specified Outpost.
" }, "CreateSite":{ "name":"CreateSite", "http":{ "method":"POST", "requestUri":"/sites" }, "input":{"shape":"CreateSiteInput"}, "output":{"shape":"CreateSiteOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Creates a site for an Outpost.
" }, "DeleteOutpost":{ "name":"DeleteOutpost", "http":{ "method":"DELETE", "requestUri":"/outposts/{OutpostId}" }, "input":{"shape":"DeleteOutpostInput"}, "output":{"shape":"DeleteOutpostOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes the specified Outpost.
" }, "DeleteQuote":{ "name":"DeleteQuote", "http":{ "method":"DELETE", "requestUri":"/quotes/{QuoteIdentifier}" }, "input":{"shape":"DeleteQuoteInput"}, "output":{"shape":"DeleteQuoteOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Deletes the specified quote.
" }, "DeleteSite":{ "name":"DeleteSite", "http":{ "method":"DELETE", "requestUri":"/sites/{SiteId}" }, "input":{"shape":"DeleteSiteInput"}, "output":{"shape":"DeleteSiteOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes the specified site.
" }, "GetCapacityTask":{ "name":"GetCapacityTask", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/capacity/{CapacityTaskId}" }, "input":{"shape":"GetCapacityTaskInput"}, "output":{"shape":"GetCapacityTaskOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Gets details of the specified capacity task.
" }, "GetCatalogItem":{ "name":"GetCatalogItem", "http":{ "method":"GET", "requestUri":"/catalog/item/{CatalogItemId}" }, "input":{"shape":"GetCatalogItemInput"}, "output":{"shape":"GetCatalogItemOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Gets information about the specified catalog item.
" }, "GetConnection":{ "name":"GetConnection", "http":{ "method":"GET", "requestUri":"/connections/{ConnectionId}" }, "input":{"shape":"GetConnectionRequest"}, "output":{"shape":"GetConnectionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Amazon Web Services uses this action to install Outpost servers.
Gets information about the specified connection.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
" }, "GetOrder":{ "name":"GetOrder", "http":{ "method":"GET", "requestUri":"/orders/{OrderId}" }, "input":{"shape":"GetOrderInput"}, "output":{"shape":"GetOrderOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Gets information about the specified order.
" }, "GetOutpost":{ "name":"GetOutpost", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}" }, "input":{"shape":"GetOutpostInput"}, "output":{"shape":"GetOutpostOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Gets information about the specified Outpost.
" }, "GetOutpostBillingInformation":{ "name":"GetOutpostBillingInformation", "http":{ "method":"GET", "requestUri":"/outpost/{OutpostIdentifier}/billing-information" }, "input":{"shape":"GetOutpostBillingInformationInput"}, "output":{"shape":"GetOutpostBillingInformationOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"NotFoundException"} ], "documentation":"Gets current and historical billing information about the specified Outpost.
" }, "GetOutpostInstanceTypes":{ "name":"GetOutpostInstanceTypes", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/instanceTypes" }, "input":{"shape":"GetOutpostInstanceTypesInput"}, "output":{"shape":"GetOutpostInstanceTypesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Gets the instance types for the specified Outpost.
" }, "GetOutpostSupportedInstanceTypes":{ "name":"GetOutpostSupportedInstanceTypes", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/supportedInstanceTypes" }, "input":{"shape":"GetOutpostSupportedInstanceTypesInput"}, "output":{"shape":"GetOutpostSupportedInstanceTypesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.
Gets information about the specified quote.
" }, "GetRenewalPricing":{ "name":"GetRenewalPricing", "http":{ "method":"GET", "requestUri":"/outpost/{OutpostIdentifier}/renewal-pricing" }, "input":{"shape":"GetRenewalPricingInput"}, "output":{"shape":"GetRenewalPricingOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"NotFoundException"}, {"shape":"ValidationException"} ], "documentation":"Gets all available renewal pricing options for the specified Outpost.
" }, "GetSite":{ "name":"GetSite", "http":{ "method":"GET", "requestUri":"/sites/{SiteId}" }, "input":{"shape":"GetSiteInput"}, "output":{"shape":"GetSiteOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Gets information about the specified Outpost site.
" }, "GetSiteAddress":{ "name":"GetSiteAddress", "http":{ "method":"GET", "requestUri":"/sites/{SiteId}/address" }, "input":{"shape":"GetSiteAddressInput"}, "output":{"shape":"GetSiteAddressOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Gets the site address of the specified site.
" }, "ListAssetInstances":{ "name":"ListAssetInstances", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/assetInstances" }, "input":{"shape":"ListAssetInstancesInput"}, "output":{"shape":"ListAssetInstancesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.
" }, "ListAssets":{ "name":"ListAssets", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/assets" }, "input":{"shape":"ListAssetsInput"}, "output":{"shape":"ListAssetsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the hardware assets for the specified Outpost.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
" }, "ListBlockingInstancesForCapacityTask":{ "name":"ListBlockingInstancesForCapacityTask", "http":{ "method":"GET", "requestUri":"/outposts/{OutpostId}/capacity/{CapacityTaskId}/blockingInstances" }, "input":{"shape":"ListBlockingInstancesForCapacityTaskInput"}, "output":{"shape":"ListBlockingInstancesForCapacityTaskOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"A list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task. Use this list to specify the instances you cannot stop to free up capacity to run the capacity task.
" }, "ListCapacityTasks":{ "name":"ListCapacityTasks", "http":{ "method":"GET", "requestUri":"/capacity/tasks" }, "input":{"shape":"ListCapacityTasksInput"}, "output":{"shape":"ListCapacityTasksOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the capacity tasks for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
" }, "ListCatalogItems":{ "name":"ListCatalogItems", "http":{ "method":"GET", "requestUri":"/catalog/items" }, "input":{"shape":"ListCatalogItemsInput"}, "output":{"shape":"ListCatalogItemsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the items in the catalog.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
" }, "ListOrderableInstanceTypes":{ "name":"ListOrderableInstanceTypes", "http":{ "method":"GET", "requestUri":"/instanceTypes" }, "input":{"shape":"ListOrderableInstanceTypesInput"}, "output":{"shape":"ListOrderableInstanceTypesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the instance types that can be ordered for an Outpost. You can filter the results by Outpost generation.
" }, "ListOrders":{ "name":"ListOrders", "http":{ "method":"GET", "requestUri":"/list-orders" }, "input":{"shape":"ListOrdersInput"}, "output":{"shape":"ListOrdersOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the Outpost orders for your Amazon Web Services account.
" }, "ListOutposts":{ "name":"ListOutposts", "http":{ "method":"GET", "requestUri":"/outposts" }, "input":{"shape":"ListOutpostsInput"}, "output":{"shape":"ListOutpostsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the Outposts for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
" }, "ListQuotes":{ "name":"ListQuotes", "http":{ "method":"GET", "requestUri":"/quotes" }, "input":{"shape":"ListQuotesInput"}, "output":{"shape":"ListQuotesOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the quotes for your Amazon Web Services account.
" }, "ListSites":{ "name":"ListSites", "http":{ "method":"GET", "requestUri":"/sites" }, "input":{"shape":"ListSitesInput"}, "output":{"shape":"ListSitesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"NotFoundException"} ], "documentation":"Lists the tags for the specified resource.
" }, "StartCapacityTask":{ "name":"StartCapacityTask", "http":{ "method":"POST", "requestUri":"/outposts/{OutpostId}/capacity" }, "input":{"shape":"StartCapacityTaskInput"}, "output":{"shape":"StartCapacityTaskOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.
" }, "StartConnection":{ "name":"StartConnection", "http":{ "method":"POST", "requestUri":"/connections" }, "input":{"shape":"StartConnectionRequest"}, "output":{"shape":"StartConnectionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"NotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Amazon Web Services uses this action to install Outpost servers.
Starts the connection required for Outpost server installation.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
" }, "StartOutpostDecommission":{ "name":"StartOutpostDecommission", "http":{ "method":"POST", "requestUri":"/outposts/{OutpostId}/decommission" }, "input":{"shape":"StartOutpostDecommissionInput"}, "output":{"shape":"StartOutpostDecommissionOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Starts the decommission process to return the Outposts racks or servers.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{ResourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"NotFoundException"} ], "documentation":"Adds tags to the specified resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{ResourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"NotFoundException"} ], "documentation":"Removes tags from the specified resource.
" }, "UpdateOutpost":{ "name":"UpdateOutpost", "http":{ "method":"PATCH", "requestUri":"/outposts/{OutpostId}" }, "input":{"shape":"UpdateOutpostInput"}, "output":{"shape":"UpdateOutpostOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Updates an Outpost.
" }, "UpdateQuote":{ "name":"UpdateQuote", "http":{ "method":"PATCH", "requestUri":"/quotes/{QuoteIdentifier}" }, "input":{"shape":"UpdateQuoteInput"}, "output":{"shape":"UpdateQuoteOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.
" }, "UpdateSite":{ "name":"UpdateSite", "http":{ "method":"PATCH", "requestUri":"/sites/{SiteId}" }, "input":{"shape":"UpdateSiteInput"}, "output":{"shape":"UpdateSiteOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Updates the specified site.
" }, "UpdateSiteAddress":{ "name":"UpdateSiteAddress", "http":{ "method":"PUT", "requestUri":"/sites/{SiteId}/address" }, "input":{"shape":"UpdateSiteAddressInput"}, "output":{"shape":"UpdateSiteAddressOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], "documentation":"Updates the address of the specified site.
You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
" }, "UpdateSiteRackPhysicalProperties":{ "name":"UpdateSiteRackPhysicalProperties", "http":{ "method":"PATCH", "requestUri":"/sites/{SiteId}/rackPhysicalProperties" }, "input":{"shape":"UpdateSiteRackPhysicalPropertiesInput"}, "output":{"shape":"UpdateSiteRackPhysicalPropertiesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.
You do not have permission to perform this operation.
", "error":{"httpStatusCode":403}, "exception":true }, "AccountId":{ "type":"string", "documentation":"The ID of the Amazon Web Services account.
", "max":12, "min":12, "pattern":"\\d{12}" }, "AccountIdList":{ "type":"list", "member":{"shape":"AccountId"} }, "Address":{ "type":"structure", "required":[ "ContactName", "ContactPhoneNumber", "AddressLine1", "City", "StateOrRegion", "PostalCode", "CountryCode" ], "members":{ "ContactName":{ "shape":"ContactName", "documentation":"The name of the contact.
" }, "ContactPhoneNumber":{ "shape":"ContactPhoneNumber", "documentation":"The phone number of the contact.
" }, "AddressLine1":{ "shape":"AddressLine1", "documentation":"The first line of the address.
" }, "AddressLine2":{ "shape":"AddressLine2", "documentation":"The second line of the address.
" }, "AddressLine3":{ "shape":"AddressLine3", "documentation":"The third line of the address.
" }, "City":{ "shape":"City", "documentation":"The city for the address.
" }, "StateOrRegion":{ "shape":"StateOrRegion", "documentation":"The state for the address.
" }, "DistrictOrCounty":{ "shape":"DistrictOrCounty", "documentation":"The district or county for the address.
" }, "PostalCode":{ "shape":"PostalCode", "documentation":"The postal code for the address.
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"The ISO-3166 two-letter country code for the address.
" }, "Municipality":{ "shape":"Municipality", "documentation":"The municipality for the address.
" } }, "documentation":"Information about an address.
" }, "AddressLine1":{ "type":"string", "max":180, "min":1, "pattern":"^\\S[\\S ]*$" }, "AddressLine2":{ "type":"string", "max":60, "min":0, "pattern":"^\\S[\\S ]*$" }, "AddressLine3":{ "type":"string", "max":60, "min":0, "pattern":"^\\S[\\S ]*$" }, "AddressType":{ "type":"string", "enum":[ "SHIPPING_ADDRESS", "OPERATING_ADDRESS" ] }, "Arn":{ "type":"string", "max":1011, "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:([a-z\\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$" }, "AssetId":{ "type":"string", "max":100, "min":1, "pattern":"^(\\w+)$" }, "AssetIdInput":{ "type":"string", "max":10, "min":10, "pattern":"\\d{10}" }, "AssetIdList":{ "type":"list", "member":{"shape":"AssetId"} }, "AssetInfo":{ "type":"structure", "members":{ "AssetId":{ "shape":"AssetId", "documentation":"The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "RackId":{ "shape":"RackId", "documentation":"The rack ID of the asset.
" }, "AssetType":{ "shape":"AssetType", "documentation":"The type of the asset.
" }, "ComputeAttributes":{ "shape":"ComputeAttributes", "documentation":"Information about compute hardware assets.
" }, "AssetLocation":{ "shape":"AssetLocation", "documentation":"The position of an asset in a rack.
" } }, "documentation":"Information about hardware assets.
" }, "AssetInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the instance.
" }, "InstanceType":{ "shape":"OutpostInstanceType", "documentation":"The type of instance.
" }, "AssetId":{ "shape":"AssetId", "documentation":"The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "AccountId":{"shape":"AccountId"}, "AwsServiceName":{ "shape":"AWSServiceName", "documentation":"The Amazon Web Services service name of the instance.
" } }, "documentation":"An Amazon EC2 instance.
" }, "AssetInstanceCapacityList":{ "type":"list", "member":{"shape":"AssetInstanceTypeCapacity"} }, "AssetInstanceList":{ "type":"list", "member":{"shape":"AssetInstance"} }, "AssetInstanceTypeCapacity":{ "type":"structure", "required":[ "InstanceType", "Count" ], "members":{ "InstanceType":{ "shape":"InstanceTypeName", "documentation":"The type of instance.
" }, "Count":{ "shape":"InstanceTypeCount", "documentation":"The number of each instance type.
" } }, "documentation":"The capacity for each instance type.
" }, "AssetListDefinition":{ "type":"list", "member":{"shape":"AssetInfo"} }, "AssetLocation":{ "type":"structure", "members":{ "RackElevation":{ "shape":"RackElevation", "documentation":"The position of an asset in a rack measured in rack units.
" } }, "documentation":"Information about the position of the asset in a rack.
" }, "AssetState":{ "type":"string", "enum":[ "ACTIVE", "RETIRING", "ISOLATED", "INSTALLING" ] }, "AssetType":{ "type":"string", "enum":[ "COMPUTE", "STORAGE", "POWERSHELF", "SWITCH", "NETWORKING" ] }, "AssetTypeList":{ "type":"list", "member":{"shape":"AssetType"}, "max":5, "min":1 }, "AutoFillIdempotencyToken":{ "type":"string", "max":64, "min":1, "pattern":"^.*$" }, "AvailabilityZone":{ "type":"string", "documentation":"The Availability Zone.
", "max":1000, "min":1, "pattern":"^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\\d+[a-zA-Z]?)?$" }, "AvailabilityZoneId":{ "type":"string", "documentation":"The ID of the Availability Zone.
", "max":255, "min":1, "pattern":"^[a-zA-Z]+\\d-[a-zA-Z]+\\d$" }, "AvailabilityZoneIdList":{ "type":"list", "member":{"shape":"AvailabilityZoneId"}, "max":5, "min":1 }, "AvailabilityZoneList":{ "type":"list", "member":{"shape":"AvailabilityZone"}, "max":5, "min":1 }, "BlockingInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the blocking instance.
" }, "AccountId":{"shape":"AccountId"}, "AwsServiceName":{ "shape":"AWSServiceName", "documentation":"The Amazon Web Services service name that owns the specified blocking instance.
" } }, "documentation":"A running Amazon EC2 instance that can be stopped to free up capacity needed to run the capacity task.
" }, "BlockingInstancesList":{ "type":"list", "member":{"shape":"BlockingInstance"} }, "BlockingResourceType":{ "type":"string", "enum":[ "EC2_INSTANCE", "OUTPOST_RAM_SHARE", "LGW_ROUTING_DOMAIN", "LGW_ROUTE_TABLE", "LGW_VIRTUAL_INTERFACE_GROUP", "OUTPOST_ORDER_CANCELLABLE", "OUTPOST_ORDER_INTERVENTION_REQUIRED" ] }, "BlockingResourceTypeList":{ "type":"list", "member":{"shape":"BlockingResourceType"} }, "CIDR":{ "type":"string", "max":18, "min":9, "pattern":"^([0-9]{1,3}\\.){3}[0-9]{1,3}/[0-9]{1,2}$" }, "CIDRList":{ "type":"list", "member":{"shape":"CIDR"} }, "CancelCapacityTaskInput":{ "type":"structure", "required":[ "CapacityTaskId", "OutpostIdentifier" ], "members":{ "CapacityTaskId":{ "shape":"CapacityTaskId", "documentation":"ID of the capacity task that you want to cancel.
", "location":"uri", "locationName":"CapacityTaskId" }, "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"ID or ARN of the Outpost associated with the capacity task that you want to cancel.
", "location":"uri", "locationName":"OutpostId" } } }, "CancelCapacityTaskOutput":{ "type":"structure", "members":{} }, "CancelOrderInput":{ "type":"structure", "required":["OrderId"], "members":{ "OrderId":{ "shape":"OrderId", "documentation":"The ID of the order.
", "location":"uri", "locationName":"OrderId" } } }, "CancelOrderOutput":{ "type":"structure", "members":{} }, "CapacitySummary":{ "type":"structure", "members":{ "ExistingCapacities":{ "shape":"QuoteCapacityList", "documentation":"The existing capacities on the Outpost before the quote is fulfilled.
" }, "FinalCapacities":{ "shape":"QuoteCapacityList", "documentation":"The final capacities on the Outpost after the quote is fulfilled.
" }, "CapacityChange":{ "shape":"QuoteCapacityList", "documentation":"The change in capacity between the existing and final state.
" } }, "documentation":"A summary of the capacity changes for a quote option.
" }, "CapacityTaskFailure":{ "type":"structure", "required":["Reason"], "members":{ "Reason":{ "shape":"CapacityTaskStatusReason", "documentation":"The reason that the specified capacity task failed.
" }, "Type":{ "shape":"CapacityTaskFailureType", "documentation":"The type of failure.
" } }, "documentation":"The capacity tasks that failed.
" }, "CapacityTaskFailureType":{ "type":"string", "enum":[ "UNSUPPORTED_CAPACITY_CONFIGURATION", "UNEXPECTED_ASSET_STATE", "BLOCKING_INSTANCES_NOT_EVACUATED", "INTERNAL_SERVER_ERROR", "RESOURCE_NOT_FOUND" ] }, "CapacityTaskId":{ "type":"string", "max":21, "min":21, "pattern":"^cap-[a-f0-9]{17}$" }, "CapacityTaskList":{ "type":"list", "member":{"shape":"CapacityTaskSummary"} }, "CapacityTaskStatus":{ "type":"string", "enum":[ "REQUESTED", "IN_PROGRESS", "FAILED", "COMPLETED", "WAITING_FOR_EVACUATION", "CANCELLATION_IN_PROGRESS", "CANCELLED" ] }, "CapacityTaskStatusList":{ "type":"list", "member":{"shape":"CapacityTaskStatus"} }, "CapacityTaskStatusReason":{ "type":"string", "max":128 }, "CapacityTaskSummary":{ "type":"structure", "members":{ "CapacityTaskId":{ "shape":"CapacityTaskId", "documentation":"The ID of the specified capacity task.
" }, "OutpostId":{ "shape":"OutpostId", "documentation":"The ID of the Outpost associated with the specified capacity task.
" }, "OrderId":{ "shape":"OrderId", "documentation":"The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
" }, "AssetId":{ "shape":"AssetId", "documentation":"The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "CapacityTaskStatus":{ "shape":"CapacityTaskStatus", "documentation":"The status of the capacity task.
" }, "CreationDate":{ "shape":"ISO8601Timestamp", "documentation":"The date that the specified capacity task was created.
" }, "CompletionDate":{ "shape":"ISO8601Timestamp", "documentation":"The date that the specified capacity task successfully ran.
" }, "LastModifiedDate":{ "shape":"ISO8601Timestamp", "documentation":"The date that the specified capacity was last modified.
" } }, "documentation":"The summary of the capacity task.
" }, "CatalogItem":{ "type":"structure", "members":{ "CatalogItemId":{ "shape":"SkuCode", "documentation":"The ID of the catalog item.
" }, "ItemStatus":{ "shape":"CatalogItemStatus", "documentation":"The status of a catalog item.
" }, "EC2Capacities":{ "shape":"EC2CapacityListDefinition", "documentation":"Information about the EC2 capacity of an item.
" }, "PowerKva":{ "shape":"CatalogItemPowerKva", "documentation":"Information about the power draw of an item.
" }, "WeightLbs":{ "shape":"CatalogItemWeightLbs", "documentation":"The weight of the item in pounds.
" }, "SupportedUplinkGbps":{ "shape":"SupportedUplinkGbpsListDefinition", "documentation":"The uplink speed this catalog item requires for the connection to the Region.
" }, "SupportedStorage":{ "shape":"SupportedStorageList", "documentation":"The supported storage options for the catalog item.
" } }, "documentation":"Information about a catalog item.
" }, "CatalogItemClass":{ "type":"string", "enum":[ "RACK", "SERVER" ] }, "CatalogItemClassList":{ "type":"list", "member":{"shape":"CatalogItemClass"} }, "CatalogItemListDefinition":{ "type":"list", "member":{"shape":"CatalogItem"} }, "CatalogItemPowerKva":{ "type":"float", "box":true }, "CatalogItemStatus":{ "type":"string", "enum":[ "AVAILABLE", "DISCONTINUED" ] }, "CatalogItemWeightLbs":{ "type":"integer", "box":true }, "City":{ "type":"string", "max":50, "min":1, "pattern":"^\\S[\\S ]*$" }, "CityList":{ "type":"list", "member":{"shape":"City"} }, "ComputeAssetState":{ "type":"string", "enum":[ "ACTIVE", "ISOLATED", "RETIRING", "INSTALLING" ] }, "ComputeAttributes":{ "type":"structure", "members":{ "HostId":{ "shape":"HostId", "documentation":"The host ID of the Dedicated Host on the asset.
" }, "State":{ "shape":"ComputeAssetState", "documentation":"The state.
ACTIVE - The asset is available and can provide capacity for new compute resources.
ISOLATED - The asset is undergoing maintenance and can't provide capacity for new compute resources. Existing compute resources on the asset are not affected.
RETIRING - The underlying hardware for the asset is degraded. Capacity for new compute resources is reduced. Amazon Web Services sends notifications for resources that must be stopped before the asset can be replaced.
INSTALLING - The asset is being installed and can't yet provide capacity for new compute resources.
A list of the names of instance families that are currently associated with a given asset.
" }, "InstanceTypeCapacities":{ "shape":"AssetInstanceCapacityList", "documentation":"The instance type capacities configured for this asset. This can be changed through a capacity task.
" }, "MaxVcpus":{ "shape":"VCPUCount", "documentation":"The maximum number of vCPUs possible for the specified asset.
" } }, "documentation":"Information about compute hardware assets.
" }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"}, "ResourceId":{ "shape":"String", "documentation":"The ID of the resource causing the conflict.
" }, "ResourceType":{ "shape":"ResourceType", "documentation":"The type of the resource causing the conflict.
" } }, "documentation":"Updating or deleting this resource can cause an inconsistent state.
", "error":{"httpStatusCode":409}, "exception":true }, "ConnectionDetails":{ "type":"structure", "members":{ "ClientPublicKey":{ "shape":"WireGuardPublicKey", "documentation":"The public key of the client.
" }, "ServerPublicKey":{ "shape":"WireGuardPublicKey", "documentation":"The public key of the server.
" }, "ServerEndpoint":{ "shape":"ServerEndpoint", "documentation":"The endpoint for the server.
" }, "ClientTunnelAddress":{ "shape":"CIDR", "documentation":"The client tunnel address.
" }, "ServerTunnelAddress":{ "shape":"CIDR", "documentation":"The server tunnel address.
" }, "AllowedIps":{ "shape":"CIDRList", "documentation":"The allowed IP addresses.
" } }, "documentation":"Information about a connection.
" }, "ConnectionId":{ "type":"string", "max":1024, "min":1, "pattern":"^[a-zA-Z0-9+/=]{1,1024}$" }, "ConstraintValue":{ "type":"string", "max":2048, "min":1, "pattern":"^[\\S \\n]+$" }, "ContactName":{ "type":"string", "max":255, "min":1, "pattern":"^\\S[\\S ]*$" }, "ContactPhoneNumber":{ "type":"string", "max":20, "min":1, "pattern":"^[\\S ]+$" }, "CountryCode":{ "type":"string", "max":2, "min":2, "pattern":"^[A-Z]{2}$" }, "CountryCodeList":{ "type":"list", "member":{"shape":"CountryCode"} }, "CreateOrderInput":{ "type":"structure", "required":[ "OutpostIdentifier", "PaymentOption" ], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or the Amazon Resource Name (ARN) of the Outpost.
" }, "QuoteIdentifier":{ "shape":"QuoteIdentifier", "documentation":"The ID of the quote to use for the order.
" }, "QuoteOptionIdentifier":{ "shape":"QuoteOptionIdentifier", "documentation":"The ID of the quote option to use for the order.
" }, "LineItems":{ "shape":"LineItemRequestListDefinition", "documentation":"The line items that make up the order.
" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment terms.
" } } }, "CreateOrderOutput":{ "type":"structure", "members":{ "Order":{ "shape":"Order", "documentation":"Information about this order.
" } } }, "CreateOutpostInput":{ "type":"structure", "required":[ "Name", "SiteId" ], "members":{ "Name":{"shape":"OutpostName"}, "Description":{"shape":"OutpostDescription"}, "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
" }, "AvailabilityZone":{"shape":"AvailabilityZone"}, "AvailabilityZoneId":{"shape":"AvailabilityZoneId"}, "Tags":{ "shape":"TagMap", "documentation":"The tags to apply to the Outpost.
" }, "SupportedHardwareType":{ "shape":"SupportedHardwareType", "documentation":"The type of hardware for this Outpost.
" } } }, "CreateOutpostOutput":{ "type":"structure", "members":{ "Outpost":{"shape":"Outpost"} } }, "CreateQuoteInput":{ "type":"structure", "required":[ "CountryCode", "RequestedCapacities" ], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost to associate with the quote. If not specified, the quote is created without an Outpost association.
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"The country code for the Outpost site location.
" }, "RequestedCapacities":{ "shape":"QuoteCapacityList", "documentation":"The capacity requirements for the quote. Each entry specifies a capacity type (such as Amazon EC2), the unit, and the quantity. For Amazon EC2, the quantity is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, the quantity is the total desired end-state capacity of the Outpost.
" }, "RequestedConstraints":{ "shape":"QuoteConstraintList", "documentation":"The physical constraints for the quote, such as maximum number of racks, maximum power draw per rack, or maximum weight per rack.
" }, "RequestedPaymentOptions":{ "shape":"PaymentOptionList", "documentation":"The payment options to include in the quote pricing. If not specified, all available payment options are returned.
" }, "RequestedPaymentTerms":{ "shape":"PaymentTermList", "documentation":"The payment terms to include in the quote pricing. If not specified, all available payment terms are returned.
" }, "Description":{ "shape":"QuoteDescription", "documentation":"A description for the quote.
" } } }, "CreateQuoteOutput":{ "type":"structure", "members":{ "Quote":{ "shape":"Quote", "documentation":"Information about the quote.
" } } }, "CreateRenewalInput":{ "type":"structure", "required":[ "PaymentOption", "PaymentTerm", "OutpostIdentifier" ], "members":{ "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment term.
" }, "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost.
" }, "ClientToken":{ "shape":"AutoFillIdempotencyToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true } } }, "CreateRenewalOutput":{ "type":"structure", "members":{ "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment term.
" }, "OutpostId":{ "shape":"OutpostIdOnly", "documentation":"The ID of the Outpost.
" }, "UpfrontPrice":{ "shape":"NullableFloat", "documentation":"The upfront price of the renewal.
" }, "MonthlyRecurringPrice":{ "shape":"NullableFloat", "documentation":"The monthly recurring price of the renewal.
" }, "Currency":{ "shape":"CurrencyCode", "documentation":"The currency of the renewal price.
" } } }, "CreateSiteInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{"shape":"SiteName"}, "Description":{"shape":"SiteDescription"}, "Notes":{ "shape":"SiteNotes", "documentation":"Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.
" }, "Tags":{ "shape":"TagMap", "documentation":"The tags to apply to a site.
" }, "OperatingAddress":{ "shape":"Address", "documentation":"The location to install and power on the hardware. This address might be different from the shipping address.
" }, "ShippingAddress":{ "shape":"Address", "documentation":"The location to ship the hardware. This address might be different from the operating address.
" }, "RackPhysicalProperties":{ "shape":"RackPhysicalProperties", "documentation":"Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
" } } }, "CreateSiteOutput":{ "type":"structure", "members":{ "Site":{"shape":"Site"} } }, "CurrencyCode":{ "type":"string", "enum":["USD"] }, "DecommissionRequestStatus":{ "type":"string", "enum":[ "SKIPPED", "BLOCKED", "REQUESTED" ] }, "DeleteOutpostInput":{ "type":"structure", "required":["OutpostId"], "members":{ "OutpostId":{ "shape":"OutpostId", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostId" } } }, "DeleteOutpostOutput":{ "type":"structure", "members":{} }, "DeleteQuoteInput":{ "type":"structure", "required":["QuoteIdentifier"], "members":{ "QuoteIdentifier":{ "shape":"QuoteIdentifier", "documentation":"The ID of the quote.
", "location":"uri", "locationName":"QuoteIdentifier" } } }, "DeleteQuoteOutput":{ "type":"structure", "members":{} }, "DeleteSiteInput":{ "type":"structure", "required":["SiteId"], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" } } }, "DeleteSiteOutput":{ "type":"structure", "members":{} }, "DetailedInstanceTypeItem":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"The instance type.
" }, "VCPUs":{ "shape":"VCPUCount", "documentation":"The number of default VCPUs in the instance type.
" }, "MemoryInMib":{ "shape":"MemoryInMib", "documentation":"The memory size of the instance type, in MiB.
" }, "NetworkPerformance":{ "shape":"NetworkPerformance", "documentation":"The network performance of the instance type.
" }, "FormFactorConfigs":{ "shape":"FormFactorConfigList", "documentation":"The supported form factor and Outpost generation configurations for the instance type.
" } }, "documentation":"Information about an instance type that can be ordered for an Outpost, including hardware specifications and supported form factors.
" }, "DetailedInstanceTypeListDefinition":{ "type":"list", "member":{"shape":"DetailedInstanceTypeItem"} }, "DeviceSerialNumber":{ "type":"string", "max":100, "min":1, "pattern":"^(\\w+)$" }, "DistrictOrCounty":{ "type":"string", "max":60, "min":1, "pattern":"^\\S[\\S ]*" }, "DryRun":{"type":"boolean"}, "EC2Capacity":{ "type":"structure", "members":{ "Family":{ "shape":"Family", "documentation":"The family of the EC2 capacity.
" }, "MaxSize":{ "shape":"MaxSize", "documentation":"The maximum size of the EC2 capacity.
" }, "Quantity":{ "shape":"Quantity", "documentation":"The quantity of the EC2 capacity.
" } }, "documentation":"Information about EC2 capacity.
" }, "EC2CapacityListDefinition":{ "type":"list", "member":{"shape":"EC2Capacity"} }, "EC2FamilyList":{ "type":"list", "member":{"shape":"Family"} }, "ErrorMessage":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\S \\n]+$" }, "Family":{ "type":"string", "max":10, "min":1, "pattern":"^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" }, "FiberOpticCableType":{ "type":"string", "enum":[ "SINGLE_MODE", "MULTI_MODE" ] }, "FormFactor":{ "type":"string", "enum":[ "RACK", "SERVER" ] }, "FormFactorConfig":{ "type":"structure", "members":{ "FormFactor":{ "shape":"FormFactor", "documentation":"The form factor. Valid values are RACK for rack-based Outposts and SERVER for server-based Outposts.
The Outpost generation. Valid values are GENERATION_1 for first-generation rack deployments and GENERATION_2 for second-generation rack deployments. This value is not set for server form factors.
A supported form factor and Outpost generation configuration for an instance type.
" }, "FormFactorConfigList":{ "type":"list", "member":{"shape":"FormFactorConfig"} }, "GetCapacityTaskInput":{ "type":"structure", "required":[ "CapacityTaskId", "OutpostIdentifier" ], "members":{ "CapacityTaskId":{ "shape":"CapacityTaskId", "documentation":"ID of the capacity task.
", "location":"uri", "locationName":"CapacityTaskId" }, "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"ID or ARN of the Outpost associated with the specified capacity task.
", "location":"uri", "locationName":"OutpostId" } } }, "GetCapacityTaskOutput":{ "type":"structure", "members":{ "CapacityTaskId":{ "shape":"CapacityTaskId", "documentation":"ID of the capacity task.
" }, "OutpostId":{ "shape":"OutpostId", "documentation":"ID of the Outpost associated with the specified capacity task.
" }, "OrderId":{ "shape":"OrderId", "documentation":"ID of the Amazon Web Services Outposts order associated with the specified capacity task.
" }, "AssetId":{ "shape":"AssetId", "documentation":"The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "RequestedInstancePools":{ "shape":"RequestedInstancePools", "documentation":"List of instance pools requested in the capacity task.
" }, "InstancesToExclude":{ "shape":"InstancesToExclude", "documentation":"Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.
" }, "DryRun":{ "shape":"DryRun", "documentation":"Performs a dry run to determine if you are above or below instance capacity.
" }, "CapacityTaskStatus":{ "shape":"CapacityTaskStatus", "documentation":"Status of the capacity task.
A capacity task can have one of the following statuses:
REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
IN_PROGRESS - The capacity task is running and cannot be cancelled.
FAILED - The capacity task could not be completed.
COMPLETED - The capacity task has completed successfully.
WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.
CANCELLED - The capacity task is cancelled.
Reason why the capacity task failed.
" }, "CreationDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the capacity task was created.
" }, "CompletionDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the capacity task ran successfully.
" }, "LastModifiedDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the capacity task was last modified.
" }, "TaskActionOnBlockingInstances":{ "shape":"TaskActionOnBlockingInstances", "documentation":"User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:
WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK - The capacity task fails.
The ID of the catalog item.
", "location":"uri", "locationName":"CatalogItemId" } } }, "GetCatalogItemOutput":{ "type":"structure", "members":{ "CatalogItem":{ "shape":"CatalogItem", "documentation":"Information about this catalog item.
" } } }, "GetConnectionRequest":{ "type":"structure", "required":["ConnectionId"], "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"The ID of the connection.
", "location":"uri", "locationName":"ConnectionId" } } }, "GetConnectionResponse":{ "type":"structure", "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"The ID of the connection.
" }, "ConnectionDetails":{ "shape":"ConnectionDetails", "documentation":"Information about the connection.
" } } }, "GetOrderInput":{ "type":"structure", "required":["OrderId"], "members":{ "OrderId":{ "shape":"OrderId", "documentation":"The ID of the order.
", "location":"uri", "locationName":"OrderId" } } }, "GetOrderOutput":{ "type":"structure", "members":{ "Order":{"shape":"Order"} } }, "GetOutpostBillingInformationInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostIdentifier" } } }, "GetOutpostBillingInformationOutput":{ "type":"structure", "members":{ "NextToken":{"shape":"Token"}, "Subscriptions":{ "shape":"SubscriptionList", "documentation":"The subscription details for the specified Outpost.
" }, "ContractEndDate":{ "shape":"String", "documentation":"The date the current contract term ends for the specified Outpost. You must start the renewal or decommission process at least 5 business days before the current term for your Amazon Web Services Outposts ends. Failing to complete these steps at least 5 business days before the current term ends might result in unanticipated charges.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment term.
" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option.
" } } }, "GetOutpostInput":{ "type":"structure", "required":["OutpostId"], "members":{ "OutpostId":{ "shape":"OutpostId", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostId" } } }, "GetOutpostInstanceTypesInput":{ "type":"structure", "required":["OutpostId"], "members":{ "OutpostId":{ "shape":"OutpostId", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostId" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" } } }, "GetOutpostInstanceTypesOutput":{ "type":"structure", "members":{ "InstanceTypes":{"shape":"InstanceTypeListDefinition"}, "NextToken":{"shape":"Token"}, "OutpostId":{ "shape":"OutpostId", "documentation":"The ID of the Outpost.
" }, "OutpostArn":{"shape":"OutpostArn"} } }, "GetOutpostOutput":{ "type":"structure", "members":{ "Outpost":{"shape":"Outpost"} } }, "GetOutpostSupportedInstanceTypesInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostId" }, "OrderId":{ "shape":"OrderId", "documentation":"The ID for the Amazon Web Services Outposts order.
", "location":"querystring", "locationName":"OrderId" }, "AssetId":{ "shape":"AssetIdInput", "documentation":"The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
", "location":"querystring", "locationName":"AssetId" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" } } }, "GetOutpostSupportedInstanceTypesOutput":{ "type":"structure", "members":{ "InstanceTypes":{"shape":"InstanceTypeListDefinition"}, "NextToken":{"shape":"Token"} } }, "GetQuoteInput":{ "type":"structure", "required":["QuoteIdentifier"], "members":{ "QuoteIdentifier":{ "shape":"QuoteIdentifier", "documentation":"The ID of the quote.
", "location":"uri", "locationName":"QuoteIdentifier" } } }, "GetQuoteOutput":{ "type":"structure", "members":{ "Quote":{ "shape":"Quote", "documentation":"Information about the quote.
" } } }, "GetRenewalPricingInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostIdentifier" } } }, "GetRenewalPricingOutput":{ "type":"structure", "members":{ "PricingResult":{ "shape":"PricingResult", "documentation":"The result of the pricing request.
" }, "PricingOptions":{ "shape":"PricingOptionList", "documentation":"The pricing options for the specified Outpost.
" } } }, "GetSiteAddressInput":{ "type":"structure", "required":[ "SiteId", "AddressType" ], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" }, "AddressType":{ "shape":"AddressType", "documentation":"The type of the address you request.
", "location":"querystring", "locationName":"AddressType" } } }, "GetSiteAddressOutput":{ "type":"structure", "members":{ "SiteId":{"shape":"SiteId"}, "AddressType":{ "shape":"AddressType", "documentation":"The type of the address you receive.
" }, "Address":{ "shape":"Address", "documentation":"Information about the address.
" } } }, "GetSiteInput":{ "type":"structure", "required":["SiteId"], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" } } }, "GetSiteOutput":{ "type":"structure", "members":{ "Site":{"shape":"Site"} } }, "HostId":{ "type":"string", "max":50, "min":1, "pattern":"^[A-Za-z0-9-]*$" }, "HostIdList":{ "type":"list", "member":{"shape":"HostId"} }, "ISO8601Timestamp":{"type":"timestamp"}, "InstanceFamilies":{ "type":"list", "member":{"shape":"InstanceFamilyName"} }, "InstanceFamilyName":{ "type":"string", "max":200, "min":1, "pattern":"^(?:.{1,200}/)?(?:[a-z0-9-_A-Z])+$" }, "InstanceId":{ "type":"string", "max":32, "min":11, "pattern":"^i-[0-9a-z]+$" }, "InstanceIdList":{ "type":"list", "member":{"shape":"InstanceId"} }, "InstanceType":{ "type":"string", "documentation":"The instance type.
" }, "InstanceTypeCapacity":{ "type":"structure", "required":[ "InstanceType", "Count" ], "members":{ "InstanceType":{ "shape":"InstanceTypeName", "documentation":"The instance type of the hosts.
" }, "Count":{ "shape":"InstanceTypeCount", "documentation":"The number of instances for the specified instance type.
" } }, "documentation":"The instance type that you specify determines the combination of CPU, memory, storage, and networking capacity.
" }, "InstanceTypeCount":{ "type":"integer", "max":9999, "min":0 }, "InstanceTypeItem":{ "type":"structure", "members":{ "InstanceType":{"shape":"InstanceType"}, "VCPUs":{ "shape":"VCPUCount", "documentation":"The number of default VCPUs in an instance type.
" } }, "documentation":"Information about an instance type.
" }, "InstanceTypeListDefinition":{ "type":"list", "member":{"shape":"InstanceTypeItem"}, "documentation":"Information about the instance types.
" }, "InstanceTypeName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-z0-9\\-]+\\.[a-z0-9\\-]+$" }, "InstancesToExclude":{ "type":"structure", "members":{ "Instances":{ "shape":"InstanceIdList", "documentation":"List of user-specified instances that must not be stopped.
" }, "AccountIds":{ "shape":"AccountIdList", "documentation":"IDs of the accounts that own each instance that must not be stopped.
" }, "Services":{ "shape":"AWSServiceNameList", "documentation":"Names of the services that own each instance that must not be stopped in order to free up the capacity needed to run the capacity task.
" } }, "documentation":"User-specified instances that must not be stopped. These instances will not appear in the list of instances that Amazon Web Services recommends to stop in order to free up capacity.
" }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"An internal error has occurred.
", "error":{"httpStatusCode":500}, "exception":true }, "LifeCycleStatus":{ "type":"string", "documentation":"The life cycle status.
", "max":20, "min":1, "pattern":"^[ A-Za-z]+$" }, "LifeCycleStatusList":{ "type":"list", "member":{"shape":"LifeCycleStatus"}, "max":5, "min":1 }, "LineItem":{ "type":"structure", "members":{ "CatalogItemId":{ "shape":"SkuCode", "documentation":"The ID of the catalog item.
" }, "LineItemId":{ "shape":"LineItemId", "documentation":"The ID of the line item.
" }, "Quantity":{ "shape":"LineItemQuantity", "documentation":"The quantity of the line item.
" }, "Status":{ "shape":"LineItemStatus", "documentation":"The status of the line item.
" }, "ShipmentInformation":{ "shape":"ShipmentInformation", "documentation":"Information about a line item shipment.
" }, "AssetInformationList":{ "shape":"LineItemAssetInformationList", "documentation":"Information about assets.
" }, "PreviousLineItemId":{ "shape":"LineItemId", "documentation":"The ID of the previous line item.
" }, "PreviousOrderId":{ "shape":"OrderId", "documentation":"The ID of the previous order.
" } }, "documentation":"Information about a line item.
" }, "LineItemAssetInformation":{ "type":"structure", "members":{ "AssetId":{ "shape":"AssetId", "documentation":"The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "MacAddressList":{ "shape":"MacAddressList", "documentation":"The MAC addresses of the asset.
" } }, "documentation":"Information about a line item asset.
" }, "LineItemAssetInformationList":{ "type":"list", "member":{"shape":"LineItemAssetInformation"} }, "LineItemId":{ "type":"string", "pattern":"ooi-[a-f0-9]{17}" }, "LineItemListDefinition":{ "type":"list", "member":{"shape":"LineItem"} }, "LineItemQuantity":{ "type":"integer", "min":1 }, "LineItemRequest":{ "type":"structure", "members":{ "CatalogItemId":{ "shape":"SkuCode", "documentation":"The ID of the catalog item.
" }, "Quantity":{ "shape":"LineItemQuantity", "documentation":"The quantity of a line item request.
" } }, "documentation":"Information about a line item request.
" }, "LineItemRequestListDefinition":{ "type":"list", "member":{"shape":"LineItemRequest"}, "max":20, "min":1 }, "LineItemStatus":{ "type":"string", "enum":[ "PREPARING", "BUILDING", "SHIPPED", "DELIVERED", "INSTALLING", "INSTALLED", "ERROR", "CANCELLED", "REPLACED" ] }, "LineItemStatusCounts":{ "type":"map", "key":{"shape":"LineItemStatus"}, "value":{"shape":"LineItemQuantity"} }, "ListAssetInstancesInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID of the Outpost.
", "location":"uri", "locationName":"OutpostId" }, "AssetIdFilter":{ "shape":"AssetIdList", "documentation":"Filters the results by asset ID.
", "location":"querystring", "locationName":"AssetIdFilter" }, "InstanceTypeFilter":{ "shape":"OutpostInstanceTypeList", "documentation":"Filters the results by instance ID.
", "location":"querystring", "locationName":"InstanceTypeFilter" }, "AccountIdFilter":{ "shape":"AccountIdList", "documentation":"Filters the results by account ID.
", "location":"querystring", "locationName":"AccountIdFilter" }, "AwsServiceFilter":{ "shape":"AWSServiceNameList", "documentation":"Filters the results by Amazon Web Services service.
", "location":"querystring", "locationName":"AwsServiceFilter" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" } } }, "ListAssetInstancesOutput":{ "type":"structure", "members":{ "AssetInstances":{ "shape":"AssetInstanceList", "documentation":"List of instances owned by all accounts on the Outpost. Does not include Amazon EBS or Amazon S3 instances.
" }, "NextToken":{"shape":"Token"} } }, "ListAssetsInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or the Amazon Resource Name (ARN) of the Outpost.
", "location":"uri", "locationName":"OutpostId" }, "HostIdFilter":{ "shape":"HostIdList", "documentation":"Filters the results by the host ID of a Dedicated Host.
", "location":"querystring", "locationName":"HostIdFilter" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "StatusFilter":{ "shape":"StatusList", "documentation":"Filters the results by state.
", "location":"querystring", "locationName":"StatusFilter" }, "AssetTypeFilter":{ "shape":"AssetTypeList", "documentation":"Filters the results by asset type.
COMPUTE - Server asset used for customer compute
STORAGE - Server asset used by storage services
POWERSHELF - Powershelf assets
SWITCH - Switch assets
NETWORKING - Asset managed by Amazon Web Services for networking purposes
Information about the hardware assets.
" }, "NextToken":{"shape":"Token"} } }, "ListBlockingInstancesForCapacityTaskInput":{ "type":"structure", "required":[ "OutpostIdentifier", "CapacityTaskId" ], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost associated with the specified capacity task.
", "location":"uri", "locationName":"OutpostId" }, "CapacityTaskId":{ "shape":"CapacityTaskId", "documentation":"The ID of the capacity task.
", "location":"uri", "locationName":"CapacityTaskId" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" } } }, "ListBlockingInstancesForCapacityTaskOutput":{ "type":"structure", "members":{ "BlockingInstances":{ "shape":"BlockingInstancesList", "documentation":"A list of all running Amazon EC2 instances on the Outpost. Stopping one or more of these instances can free up the capacity needed to run the capacity task.
" }, "NextToken":{"shape":"Token"} } }, "ListCapacityTasksInput":{ "type":"structure", "members":{ "OutpostIdentifierFilter":{ "shape":"OutpostIdentifier", "documentation":"Filters the results by an Outpost ID or an Outpost ARN.
", "location":"querystring", "locationName":"OutpostIdentifierFilter" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "CapacityTaskStatusFilter":{ "shape":"CapacityTaskStatusList", "documentation":"A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.
Lists all the capacity tasks.
" }, "NextToken":{"shape":"Token"} } }, "ListCatalogItemsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "ItemClassFilter":{ "shape":"CatalogItemClassList", "documentation":"Filters the results by item class.
", "location":"querystring", "locationName":"ItemClassFilter" }, "SupportedStorageFilter":{ "shape":"SupportedStorageList", "documentation":"Filters the results by storage option.
", "location":"querystring", "locationName":"SupportedStorageFilter" }, "EC2FamilyFilter":{ "shape":"EC2FamilyList", "documentation":"Filters the results by EC2 family (for example, M5).
", "location":"querystring", "locationName":"EC2FamilyFilter" } } }, "ListCatalogItemsOutput":{ "type":"structure", "members":{ "CatalogItems":{ "shape":"CatalogItemListDefinition", "documentation":"Information about the catalog items.
" }, "NextToken":{"shape":"Token"} } }, "ListOrderableInstanceTypesInput":{ "type":"structure", "members":{ "OutpostGenerationFilter":{ "shape":"OutpostGeneration", "documentation":"Filters the results by Outpost generation. Specify GENERATION_1 for first-generation rack deployments or GENERATION_2 for second-generation rack deployments.
The maximum page size.
", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"Token", "documentation":"The pagination token.
", "location":"querystring", "locationName":"NextToken" } } }, "ListOrderableInstanceTypesOutput":{ "type":"structure", "members":{ "InstanceTypes":{ "shape":"DetailedInstanceTypeListDefinition", "documentation":"Information about the instance types that can be ordered for the Outpost.
" }, "NextToken":{ "shape":"Token", "documentation":"The pagination token.
" } } }, "ListOrdersInput":{ "type":"structure", "members":{ "OutpostIdentifierFilter":{ "shape":"OutpostIdentifier", "documentation":"The ID or the Amazon Resource Name (ARN) of the Outpost.
", "location":"querystring", "locationName":"OutpostIdentifierFilter" }, "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" } } }, "ListOrdersOutput":{ "type":"structure", "members":{ "Orders":{ "shape":"OrderSummaryListDefinition", "documentation":"Information about the orders.
" }, "NextToken":{"shape":"Token"} } }, "ListOutpostsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "LifeCycleStatusFilter":{ "shape":"LifeCycleStatusList", "documentation":"Filters the results by the lifecycle status.
", "location":"querystring", "locationName":"LifeCycleStatusFilter" }, "AvailabilityZoneFilter":{ "shape":"AvailabilityZoneList", "documentation":"Filters the results by Availability Zone (for example, us-east-1a).
Filters the results by AZ ID (for example, use1-az1).
The pagination token.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "documentation":"The maximum page size.
", "location":"querystring", "locationName":"MaxResults" } } }, "ListQuotesOutput":{ "type":"structure", "members":{ "Quotes":{ "shape":"QuoteSummaryListDefinition", "documentation":"Information about the quotes.
" }, "NextToken":{ "shape":"Token", "documentation":"The pagination token.
" } } }, "ListSitesInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults1000", "location":"querystring", "locationName":"MaxResults" }, "OperatingAddressCountryCodeFilter":{ "shape":"CountryCodeList", "documentation":"Filters the results by country code.
", "location":"querystring", "locationName":"OperatingAddressCountryCodeFilter" }, "OperatingAddressStateOrRegionFilter":{ "shape":"StateOrRegionList", "documentation":"Filters the results by state or region.
", "location":"querystring", "locationName":"OperatingAddressStateOrRegionFilter" }, "OperatingAddressCityFilter":{ "shape":"CityList", "documentation":"Filters the results by city.
", "location":"querystring", "locationName":"OperatingAddressCityFilter" } } }, "ListSitesOutput":{ "type":"structure", "members":{ "Sites":{"shape":"siteListDefinition"}, "NextToken":{"shape":"Token"} } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"The resource tags.
" } } }, "MacAddress":{ "type":"string", "max":17, "min":17, "pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" }, "MacAddressList":{ "type":"list", "member":{"shape":"MacAddress"} }, "MaxResults1000":{ "type":"integer", "documentation":"The maximum page size.
", "box":true, "max":1000, "min":1 }, "MaxSize":{"type":"string"}, "MaximumSupportedWeightLbs":{ "type":"string", "enum":[ "NO_LIMIT", "MAX_1400_LBS", "MAX_1600_LBS", "MAX_1800_LBS", "MAX_2000_LBS" ] }, "MemoryInMib":{"type":"integer"}, "Municipality":{ "type":"string", "max":180, "min":0, "pattern":"^\\S[\\S ]*$" }, "NetworkInterfaceDeviceIndex":{ "type":"integer", "max":1, "min":0 }, "NetworkPerformance":{"type":"string"}, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"The specified request is not valid.
", "error":{"httpStatusCode":404}, "exception":true }, "NullableDouble":{"type":"double"}, "NullableFloat":{ "type":"float", "box":true }, "OpticalStandard":{ "type":"string", "enum":[ "OPTIC_10GBASE_SR", "OPTIC_10GBASE_IR", "OPTIC_10GBASE_LR", "OPTIC_40GBASE_SR", "OPTIC_40GBASE_ESR", "OPTIC_40GBASE_IR4_LR4L", "OPTIC_40GBASE_LR4", "OPTIC_100GBASE_SR4", "OPTIC_100GBASE_CWDM4", "OPTIC_100GBASE_LR4", "OPTIC_100G_PSM4_MSA", "OPTIC_1000BASE_LX", "OPTIC_1000BASE_SX" ] }, "Order":{ "type":"structure", "members":{ "OutpostId":{ "shape":"OutpostIdOnly", "documentation":"The ID of the Outpost in the order.
" }, "QuoteIdentifier":{ "shape":"QuoteIdentifier", "documentation":"The ID of the quote associated with the order.
" }, "QuoteOptionIdentifier":{ "shape":"QuoteOptionIdentifier", "documentation":"The ID of the quote option associated with the order.
" }, "OrderId":{ "shape":"OrderId", "documentation":"The ID of the order.
" }, "Status":{ "shape":"OrderStatus", "documentation":"The status of the order.
PREPARING - Order is received and being prepared.
IN_PROGRESS - Order is either being built or shipped. To get more details, see the line item status.
DELIVERED - Order was delivered to the Outpost site.
COMPLETED - Order is complete.
CANCELLED - Order is cancelled.
ERROR - Customer should contact support.
The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
The line items for the order
" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option for the order.
" }, "OrderSubmissionDate":{ "shape":"ISO8601Timestamp", "documentation":"The submission date for the order.
" }, "OrderFulfilledDate":{ "shape":"ISO8601Timestamp", "documentation":"The fulfillment date of the order.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment term.
" }, "OrderType":{ "shape":"OrderType", "documentation":"The type of order.
" } }, "documentation":"Information about an order.
" }, "OrderId":{ "type":"string", "max":20, "min":1, "pattern":"oo-[a-f0-9]{17}$" }, "OrderIdList":{ "type":"list", "member":{"shape":"String"} }, "OrderIdentifier":{ "type":"string", "max":20, "min":1, "pattern":"^oo-[a-f0-9]{17}$" }, "OrderStatus":{ "type":"string", "enum":[ "RECEIVED", "PENDING", "PROCESSING", "INSTALLING", "FULFILLED", "CANCELLED", "PREPARING", "IN_PROGRESS", "DELIVERED", "COMPLETED", "ERROR" ] }, "OrderSummary":{ "type":"structure", "members":{ "OutpostId":{ "shape":"OutpostIdOnly", "documentation":"The ID of the Outpost.
" }, "OrderId":{ "shape":"OrderId", "documentation":"The ID of the order.
" }, "OrderType":{ "shape":"OrderType", "documentation":"The type of order.
" }, "Status":{ "shape":"OrderStatus", "documentation":"The status of the order.
PREPARING - Order is received and is being prepared.
IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
COMPLETED - Order is complete.
CANCELLED - Order is cancelled.
ERROR - Customer should contact support.
The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
The status of all line items in the order.
" }, "OrderSubmissionDate":{ "shape":"ISO8601Timestamp", "documentation":"The submission date for the order.
" }, "OrderFulfilledDate":{ "shape":"ISO8601Timestamp", "documentation":"The fulfilment date for the order.
" } }, "documentation":"A summary of line items in your order.
" }, "OrderSummaryListDefinition":{ "type":"list", "member":{"shape":"OrderSummary"} }, "OrderType":{ "type":"string", "enum":[ "OUTPOST", "REPLACEMENT" ] }, "OrderingRequirement":{ "type":"structure", "members":{ "StatusMessage":{ "shape":"StatusMessage", "documentation":"A message about the ordering requirement.
" }, "OrderingRequirementType":{ "shape":"OrderingRequirementType", "documentation":"The type of ordering requirement. Indicates which check failed or passed.
OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state.
MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached.
VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code.
RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements.
OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address.
SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address.
COUNTRY_CODE_MISMATCH_CHECK_ERROR - The country code on the quote does not match the Outpost site country.
OUTPOST_GENERATION_MISMATCH_ERROR - The Outpost generation does not match the requested configuration.
OUTPOST_ID_MISSING_ON_QUOTE_ERROR - The quote must be associated with an Outpost before submitting an order.
ENTERPRISE_SUPPORT_ERROR - Enterprise Support is required.
SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR - The shipping address must have a contact name.
SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR - The shipping address must have a contact phone number.
SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR - The shipping address must have contact information.
OUTPOST_STATE_CHANGED_ERROR - The Outpost state has changed since the quote was created.
OUTPOST_NOT_FOUND_ERROR - The Outpost associated with the quote was not found.
OUTPOST_RENEWAL_REQUIRED_ERROR - The Outpost requires a renewal before a new order can be submitted.
UNSUPPORTED - The requirement type is not recognized.
The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.
A requirement that must be met before an order can be submitted for a quote.
" }, "OrderingRequirementList":{ "type":"list", "member":{"shape":"OrderingRequirement"}, "max":50 }, "OrderingRequirementStatus":{ "type":"string", "enum":[ "PASS", "FAIL", "EXEMPT" ] }, "OrderingRequirementType":{ "type":"string", "enum":[ "OUTPOST_ACTIVE_CHECK_ERROR", "MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR", "VALID_ZIP_CODE_CHECK_ERROR", "RACK_PHYSICAL_PROPERTIES_CHECK_ERROR", "OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR", "SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR", "COUNTRY_CODE_MISMATCH_CHECK_ERROR", "OUTPOST_GENERATION_MISMATCH_ERROR", "UNSUPPORTED", "OUTPOST_ID_MISSING_ON_QUOTE_ERROR", "ENTERPRISE_SUPPORT_ERROR", "SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR", "SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR", "SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR", "OUTPOST_STATE_CHANGED_ERROR", "OUTPOST_NOT_FOUND_ERROR", "OUTPOST_RENEWAL_REQUIRED_ERROR" ] }, "Outpost":{ "type":"structure", "members":{ "OutpostId":{ "shape":"OutpostId", "documentation":"The ID of the Outpost.
" }, "OwnerId":{"shape":"OwnerId"}, "OutpostArn":{"shape":"OutpostArn"}, "SiteId":{"shape":"SiteId"}, "Name":{"shape":"OutpostName"}, "Description":{"shape":"OutpostDescription"}, "LifeCycleStatus":{"shape":"LifeCycleStatus"}, "AvailabilityZone":{"shape":"AvailabilityZone"}, "AvailabilityZoneId":{"shape":"AvailabilityZoneId"}, "Tags":{ "shape":"TagMap", "documentation":"The Outpost tags.
" }, "SiteArn":{"shape":"SiteArn"}, "SupportedHardwareType":{ "shape":"SupportedHardwareType", "documentation":"The hardware type.
" } }, "documentation":"Information about an Outpost.
" }, "OutpostArn":{ "type":"string", "documentation":"The Amazon Resource Name (ARN) of the Outpost.
", "max":255, "min":1, "pattern":"^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" }, "OutpostDescription":{ "type":"string", "documentation":"The description of the Outpost.
", "max":1000, "min":0, "pattern":"^[\\S ]*$" }, "OutpostGeneration":{ "type":"string", "enum":[ "GENERATION_2", "GENERATION_1" ] }, "OutpostId":{ "type":"string", "max":180, "min":1, "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" }, "OutpostIdOnly":{ "type":"string", "max":20, "min":1, "pattern":"^op-[a-f0-9]{17}$" }, "OutpostIdentifier":{ "type":"string", "max":180, "min":1, "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" }, "OutpostIdentifierOrEmpty":{ "type":"string", "max":180, "min":0, "pattern":"^((arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17})?$" }, "OutpostInstanceType":{ "type":"string", "max":30, "min":3, "pattern":"[a-z0-9\\-\\.]+" }, "OutpostInstanceTypeList":{ "type":"list", "member":{"shape":"OutpostInstanceType"} }, "OutpostName":{ "type":"string", "documentation":"The name of the Outpost.
", "max":255, "min":1, "pattern":"^[\\S ]+$" }, "OwnerId":{ "type":"string", "documentation":"The Amazon Web Services account ID of the Outpost owner.
", "max":12, "min":12, "pattern":"\\d{12}" }, "PaymentOption":{ "type":"string", "enum":[ "ALL_UPFRONT", "NO_UPFRONT", "PARTIAL_UPFRONT" ] }, "PaymentOptionList":{ "type":"list", "member":{"shape":"PaymentOption"}, "max":3 }, "PaymentTerm":{ "type":"string", "enum":[ "THREE_YEARS", "ONE_YEAR", "FIVE_YEARS" ] }, "PaymentTermList":{ "type":"list", "member":{"shape":"PaymentTerm"}, "max":3 }, "PostalCode":{ "type":"string", "max":20, "min":1, "pattern":"^[a-zA-Z0-9 -]+$" }, "PowerConnector":{ "type":"string", "enum":[ "L6_30P", "IEC309", "AH530P7W", "AH532P6W", "CS8365C" ] }, "PowerDrawKva":{ "type":"string", "enum":[ "POWER_5_KVA", "POWER_10_KVA", "POWER_15_KVA", "POWER_30_KVA" ] }, "PowerFeedDrop":{ "type":"string", "enum":[ "ABOVE_RACK", "BELOW_RACK" ] }, "PowerPhase":{ "type":"string", "enum":[ "SINGLE_PHASE", "THREE_PHASE" ] }, "PricingOption":{ "type":"structure", "members":{ "PricingType":{ "shape":"QuotePricingType", "documentation":"The type of pricing model.
" }, "SubscriptionPricingDetails":{ "shape":"SubscriptionPricingDetails", "documentation":"The subscription pricing details for this pricing option.
" } }, "documentation":"A pricing option for the specified Outpost.
" }, "PricingOptionList":{ "type":"list", "member":{"shape":"PricingOption"}, "max":9 }, "PricingResult":{ "type":"string", "enum":[ "PRICED", "UNABLE_TO_PRICE" ] }, "Quantity":{"type":"string"}, "Quote":{ "type":"structure", "members":{ "QuoteId":{ "shape":"QuoteId", "documentation":"The ID of the quote.
" }, "AccountId":{ "shape":"AccountId", "documentation":"The ID of the account that owns the quote.
" }, "QuoteStatus":{ "shape":"QuoteStatus", "documentation":"The status of the quote.
CREATED - The quote has been created and is available for review.
ORDER_SUBMITTED - An order has been submitted for the quote.
EXPIRED - The quote has expired and can no longer be used to submit an order.
A message about the status of the quote.
" }, "OutpostArn":{ "shape":"OutpostArn", "documentation":"The ARN of the Outpost associated with the quote.
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"The country code for the Outpost site location.
" }, "RequestedCapacities":{ "shape":"QuoteCapacityList", "documentation":"The capacity requirements specified in the quote request.
" }, "RequestedConstraints":{ "shape":"QuoteConstraintList", "documentation":"The physical constraints specified in the quote request.
" }, "RequestedPaymentOptions":{ "shape":"PaymentOptionList", "documentation":"The payment options specified in the quote request.
" }, "RequestedPaymentTerms":{ "shape":"PaymentTermList", "documentation":"The payment terms specified in the quote request.
" }, "QuoteOptions":{ "shape":"QuoteOptionList", "documentation":"The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.
" }, "OrderingRequirements":{ "shape":"OrderingRequirementList", "documentation":"The requirements that must be met before an order can be submitted for the quote.
" }, "SubmittedOrderId":{ "shape":"OrderIdentifier", "documentation":"The ID of the order submitted for the quote.
" }, "CreatedDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the quote was created.
" }, "ExpirationDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the quote expires.
" }, "Description":{ "shape":"QuoteDescription", "documentation":"The description of the quote.
" } }, "documentation":"Information about a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity.
" }, "QuoteCapacity":{ "type":"structure", "members":{ "QuoteCapacityType":{ "shape":"QuoteCapacityType", "documentation":"The type of capacity. Valid values are EC2, EBS, and S3.
The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).
The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.
" } }, "documentation":"A capacity requirement for a quote. Specifies the type of capacity, the unit, and the quantity.
" }, "QuoteCapacityList":{ "type":"list", "member":{"shape":"QuoteCapacity"}, "max":2000 }, "QuoteCapacityType":{ "type":"string", "enum":[ "EC2", "EBS", "S3" ] }, "QuoteConstraint":{ "type":"structure", "members":{ "QuoteConstraintType":{ "shape":"QuoteConstraintType", "documentation":"The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, and RACK_MAX_WEIGHT_LBS.
The value of the constraint.
" } }, "documentation":"A physical constraint for a quote.
" }, "QuoteConstraintList":{ "type":"list", "member":{"shape":"QuoteConstraint"}, "max":10 }, "QuoteConstraintType":{ "type":"string", "enum":[ "RACK_MAXIMUM", "RACK_MAX_POWER_KVA", "RACK_MAX_WEIGHT_LBS" ] }, "QuoteDescription":{ "type":"string", "max":1024, "min":0, "pattern":"^[\\S \\n]*$", "sensitive":true }, "QuoteId":{ "type":"string", "max":255, "min":1, "pattern":"^oq-[a-f0-9]{17}$" }, "QuoteIdentifier":{ "type":"string", "max":255, "min":1, "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:quote/)?oq-[a-f0-9]{17}$" }, "QuoteOption":{ "type":"structure", "members":{ "QuoteOptionIdentifier":{ "shape":"QuoteOptionIdentifier", "documentation":"The ID of the quote option.
" }, "Capacities":{ "shape":"QuoteCapacityList", "documentation":"The capacities included in this quote option.
" }, "CapacitySummary":{ "shape":"CapacitySummary", "documentation":"A summary of the existing, final, and changed capacity for this quote option.
" }, "Specifications":{ "shape":"QuoteSpecificationList", "documentation":"The physical specifications for the racks or servers in this quote option.
" }, "PricingOptions":{ "shape":"PricingOptionList", "documentation":"The pricing options for this quote option.
" } }, "documentation":"A configuration and pricing option for a quote. Each option includes the capacity breakdown, physical specifications for the racks or servers, and pricing details.
" }, "QuoteOptionIdentifier":{ "type":"string", "max":21, "min":1, "pattern":"^oqo-[a-f0-9]{17}$" }, "QuoteOptionList":{ "type":"list", "member":{"shape":"QuoteOption"}, "max":10 }, "QuotePricingType":{ "type":"string", "enum":["SUBSCRIPTION"] }, "QuoteRackUseType":{ "type":"string", "enum":[ "NETWORKING", "COMPUTE" ] }, "QuoteSpecification":{ "type":"structure", "members":{ "QuoteSpecificationType":{ "shape":"QuoteSpecificationType", "documentation":"The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.
The existing rack specification details, if the specification type is UPDATED_RACK or EXISTING_RACK.
The final rack specification details after the quote is fulfilled.
" }, "ServerSpecificationDetails":{ "shape":"ServerSpecificationDetails", "documentation":"The server specification details, if the specification type is SERVER.
A physical specification for a quote option. Describes the rack or server configuration that would be deployed.
" }, "QuoteSpecificationList":{ "type":"list", "member":{"shape":"QuoteSpecification"}, "max":100 }, "QuoteSpecificationType":{ "type":"string", "enum":[ "UPDATED_RACK", "NEW_RACK", "EXISTING_RACK", "SERVER" ] }, "QuoteStatus":{ "type":"string", "enum":[ "CREATED", "ORDER_SUBMITTED", "EXPIRED" ] }, "QuoteSummary":{ "type":"structure", "members":{ "QuoteId":{ "shape":"QuoteId", "documentation":"The ID of the quote.
" }, "AccountId":{ "shape":"AccountId", "documentation":"The ID of the account that owns the quote.
" }, "QuoteStatus":{ "shape":"QuoteStatus", "documentation":"The status of the quote.
" }, "StatusMessage":{ "shape":"StatusMessage", "documentation":"A message about the status of the quote.
" }, "OutpostArn":{ "shape":"OutpostArn", "documentation":"The ARN of the Outpost associated with the quote.
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"The country code for the Outpost site location.
" }, "RequestedCapacities":{ "shape":"QuoteCapacityList", "documentation":"The capacity requirements specified in the quote request.
" }, "RequestedConstraints":{ "shape":"QuoteConstraintList", "documentation":"The physical constraints specified in the quote request.
" }, "RequestedPaymentOptions":{ "shape":"PaymentOptionList", "documentation":"The payment options specified in the quote request.
" }, "RequestedPaymentTerms":{ "shape":"PaymentTermList", "documentation":"The payment terms specified in the quote request.
" }, "QuoteOptions":{ "shape":"QuoteOptionList", "documentation":"The configuration and pricing options for the quote.
" }, "SubmittedOrderId":{ "shape":"OrderIdentifier", "documentation":"The ID of the order submitted for the quote.
" }, "CreatedDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the quote was created.
" }, "ExpirationDate":{ "shape":"ISO8601Timestamp", "documentation":"The date the quote expires.
" }, "Description":{ "shape":"QuoteDescription", "documentation":"The description of the quote.
" } }, "documentation":"Summary information about a quote.
" }, "QuoteSummaryListDefinition":{ "type":"list", "member":{"shape":"QuoteSummary"}, "max":1000 }, "RackElevation":{ "type":"float", "box":true, "max":99, "min":0 }, "RackId":{ "type":"string", "max":20, "min":5, "pattern":"^[\\S \\n]+$" }, "RackPhysicalProperties":{ "type":"structure", "members":{ "PowerDrawKva":{ "shape":"PowerDrawKva", "documentation":"The power draw available at the hardware placement position for the rack.
" }, "PowerPhase":{ "shape":"PowerPhase", "documentation":"The power option that you can provide for hardware.
" }, "PowerConnector":{ "shape":"PowerConnector", "documentation":"The power connector for the hardware.
" }, "PowerFeedDrop":{ "shape":"PowerFeedDrop", "documentation":"The position of the power feed.
" }, "UplinkGbps":{ "shape":"UplinkGbps", "documentation":"The uplink speed the rack supports for the connection to the Region.
" }, "UplinkCount":{ "shape":"UplinkCount", "documentation":"The number of uplinks each Outpost network device.
" }, "FiberOpticCableType":{ "shape":"FiberOpticCableType", "documentation":"The type of fiber used to attach the Outpost to the network.
" }, "OpticalStandard":{ "shape":"OpticalStandard", "documentation":"The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
" }, "MaximumSupportedWeightLbs":{ "shape":"MaximumSupportedWeightLbs", "documentation":"The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).
Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
" }, "RackSpecificationDetails":{ "type":"structure", "members":{ "RackId":{ "shape":"RackId", "documentation":"The ID of the rack.
" }, "RackUse":{ "shape":"QuoteRackUseType", "documentation":"The use of the rack. Valid values are COMPUTE and NETWORKING.
The maximum power draw of the rack in kVA.
" }, "RackWeightLbs":{ "shape":"NullableFloat", "documentation":"The weight of the rack in pounds.
" }, "RackHeightInches":{ "shape":"NullableFloat", "documentation":"The height of the rack in inches.
" }, "RackWidthInches":{ "shape":"NullableFloat", "documentation":"The width of the rack in inches.
" }, "RackDepthInches":{ "shape":"NullableFloat", "documentation":"The depth of the rack in inches.
" }, "RackUnitHeight":{ "shape":"RackUnitHeight", "documentation":"The rack unit height.
HEIGHT_42U - 42 rack units.
HEIGHT_2U - 2 rack units.
HEIGHT_1U - 1 rack unit.
The Amazon EC2 capacities for the rack.
" } }, "documentation":"The physical specification details for a rack in a quote option.
" }, "RackUnitHeight":{ "type":"string", "enum":[ "HEIGHT_42U", "HEIGHT_2U", "HEIGHT_1U" ] }, "RequestedInstancePools":{ "type":"list", "member":{"shape":"InstanceTypeCapacity"} }, "ResourceType":{ "type":"string", "enum":[ "OUTPOST", "ORDER" ] }, "ServerEndpoint":{ "type":"string", "max":21, "min":9, "pattern":"^([0-9]{1,3}\\.){3}[0-9]{1,3}:[0-9]{1,5}$" }, "ServerSpecificationDetails":{ "type":"structure", "members":{ "ServerPowerDrawKva":{ "shape":"NullableFloat", "documentation":"The maximum power draw of the server in kVA.
" }, "ServerWeightLbs":{ "shape":"NullableFloat", "documentation":"The weight of the server in pounds.
" }, "ServerHeightInches":{ "shape":"NullableFloat", "documentation":"The height of the server in inches.
" }, "ServerWidthInches":{ "shape":"NullableFloat", "documentation":"The width of the server in inches.
" }, "ServerDepthInches":{ "shape":"NullableFloat", "documentation":"The depth of the server in inches.
" }, "RackUnitHeight":{ "shape":"RackUnitHeight", "documentation":"The rack unit height of the server.
HEIGHT_2U - 2 rack units.
HEIGHT_1U - 1 rack unit.
The Amazon EC2 capacities for the server.
" } }, "documentation":"The physical specification details for a server in a quote option.
" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"You have exceeded a service quota.
", "error":{"httpStatusCode":402}, "exception":true }, "ShipmentCarrier":{ "type":"string", "enum":[ "DHL", "DBS", "FEDEX", "UPS", "EXPEDITORS" ] }, "ShipmentInformation":{ "type":"structure", "members":{ "ShipmentTrackingNumber":{ "shape":"TrackingId", "documentation":"The tracking number of the shipment.
" }, "ShipmentCarrier":{ "shape":"ShipmentCarrier", "documentation":"The carrier of the shipment.
" } }, "documentation":"Information about a line item shipment.
" }, "Site":{ "type":"structure", "members":{ "SiteId":{"shape":"SiteId"}, "AccountId":{"shape":"AccountId"}, "Name":{"shape":"SiteName"}, "Description":{"shape":"SiteDescription"}, "Tags":{ "shape":"TagMap", "documentation":"The site tags.
" }, "SiteArn":{"shape":"SiteArn"}, "Notes":{ "shape":"SiteNotes", "documentation":"Notes about a site.
" }, "OperatingAddressCountryCode":{ "shape":"CountryCode", "documentation":"The ISO-3166 two-letter country code where the hardware is installed and powered on.
" }, "OperatingAddressStateOrRegion":{ "shape":"StateOrRegion", "documentation":"State or region where the hardware is installed and powered on.
" }, "OperatingAddressCity":{ "shape":"City", "documentation":"City where the hardware is installed and powered on.
" }, "RackPhysicalProperties":{ "shape":"RackPhysicalProperties", "documentation":"Information about the physical and logistical details for a rack at the site.
" } }, "documentation":"Information about a site.
" }, "SiteArn":{ "type":"string", "documentation":"The Amazon Resource Name (ARN) of the site.
", "max":255, "min":1, "pattern":"^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:site/(os-[a-f0-9]{17})$" }, "SiteDescription":{ "type":"string", "documentation":"The description of the site.
", "max":1001, "min":1, "pattern":"^[\\S ]+$" }, "SiteId":{ "type":"string", "documentation":"The ID of the site.
", "max":255, "min":1, "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:site/)?(os-[a-f0-9]{17})$" }, "SiteName":{ "type":"string", "documentation":"The name of the site.
", "max":1000, "min":1, "pattern":"^[\\S ]+$" }, "SiteNotes":{ "type":"string", "max":2000, "min":1, "pattern":"^[\\S \\n]+$" }, "SkuCode":{ "type":"string", "max":10, "min":1, "pattern":"OR-[A-Z0-9]{7}" }, "StartCapacityTaskInput":{ "type":"structure", "required":[ "OutpostIdentifier", "InstancePools" ], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outposts associated with the specified capacity task.
", "location":"uri", "locationName":"OutpostId" }, "OrderId":{ "shape":"OrderId", "documentation":"The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
" }, "AssetId":{ "shape":"AssetIdInput", "documentation":"The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "InstancePools":{ "shape":"RequestedInstancePools", "documentation":"The instance pools specified in the capacity task.
" }, "InstancesToExclude":{ "shape":"InstancesToExclude", "documentation":"List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.
" }, "DryRun":{ "shape":"DryRun", "documentation":"You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.
" }, "TaskActionOnBlockingInstances":{ "shape":"TaskActionOnBlockingInstances", "documentation":"Specify one of the following options in case an instance is blocking the capacity task from running.
WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK - The capacity task fails.
ID of the capacity task that you want to start.
" }, "OutpostId":{ "shape":"OutpostId", "documentation":"ID of the Outpost associated with the capacity task.
" }, "OrderId":{ "shape":"OrderId", "documentation":"ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
" }, "AssetId":{ "shape":"AssetId", "documentation":"The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
" }, "RequestedInstancePools":{ "shape":"RequestedInstancePools", "documentation":"List of the instance pools requested in the specified capacity task.
" }, "InstancesToExclude":{ "shape":"InstancesToExclude", "documentation":"User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.
" }, "DryRun":{ "shape":"DryRun", "documentation":"Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
" }, "CapacityTaskStatus":{ "shape":"CapacityTaskStatus", "documentation":"Status of the specified capacity task.
" }, "Failed":{ "shape":"CapacityTaskFailure", "documentation":"Reason that the specified capacity task failed.
" }, "CreationDate":{ "shape":"ISO8601Timestamp", "documentation":"Date that the specified capacity task was created.
" }, "CompletionDate":{ "shape":"ISO8601Timestamp", "documentation":"Date that the specified capacity task ran successfully.
" }, "LastModifiedDate":{ "shape":"ISO8601Timestamp", "documentation":"Date that the specified capacity task was last modified.
" }, "TaskActionOnBlockingInstances":{ "shape":"TaskActionOnBlockingInstances", "documentation":"User-specified option in case an instance is blocking the capacity task from running.
WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.
FAIL_TASK - The capacity task fails.
The serial number of the dongle.
" }, "AssetId":{ "shape":"AssetId", "documentation":"The ID of the Outpost server.
" }, "ClientPublicKey":{ "shape":"WireGuardPublicKey", "documentation":"The public key of the client.
" }, "NetworkInterfaceDeviceIndex":{ "shape":"NetworkInterfaceDeviceIndex", "documentation":"The device index of the network interface on the Outpost server.
" } } }, "StartConnectionResponse":{ "type":"structure", "members":{ "ConnectionId":{ "shape":"ConnectionId", "documentation":"The ID of the connection.
" }, "UnderlayIpAddress":{ "shape":"UnderlayIpAddress", "documentation":"The underlay IP address.
" } } }, "StartOutpostDecommissionInput":{ "type":"structure", "required":["OutpostIdentifier"], "members":{ "OutpostIdentifier":{ "shape":"OutpostIdentifier", "documentation":"The ID or ARN of the Outpost that you want to decommission.
", "location":"uri", "locationName":"OutpostId" }, "ValidateOnly":{ "shape":"ValidateOnly", "documentation":"Validates the request without starting the decommission process.
" } } }, "StartOutpostDecommissionOutput":{ "type":"structure", "members":{ "Status":{ "shape":"DecommissionRequestStatus", "documentation":"The status of the decommission request.
" }, "BlockingResourceTypes":{ "shape":"BlockingResourceTypeList", "documentation":"The resources still associated with the Outpost that you are decommissioning.
" } } }, "StateOrRegion":{ "type":"string", "max":50, "min":1, "pattern":"^\\S[\\S ]*$" }, "StateOrRegionList":{ "type":"list", "member":{"shape":"StateOrRegion"} }, "StatusList":{ "type":"list", "member":{"shape":"AssetState"}, "max":5, "min":1 }, "StatusMessage":{ "type":"string", "max":2048, "min":1, "pattern":"^[\\S \\n]+$" }, "String":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\S \\n]+$" }, "Subscription":{ "type":"structure", "members":{ "SubscriptionId":{ "shape":"String", "documentation":"The ID of the subscription that appears on the Amazon Web Services Billing Center console.
" }, "SubscriptionType":{ "shape":"SubscriptionType", "documentation":"The type of subscription which can be one of the following:
ORIGINAL - The first order on the Amazon Web Services Outposts.
RENEWAL - Renewal requests, both month to month and longer term.
CAPACITY_INCREASE - Capacity scaling orders.
The status of subscription which can be one of the following:
INACTIVE - Subscription requests that are inactive.
ACTIVE - Subscription requests that are in progress and have an end date in the future.
PENDING - Subscription has been created but billing has not yet commenced because the subscription begin date has not been reached.
CANCELLED - Subscription requests that are cancelled.
The order ID for your subscription.
" }, "BeginDate":{ "shape":"ISO8601Timestamp", "documentation":"The date your subscription starts.
" }, "EndDate":{ "shape":"ISO8601Timestamp", "documentation":"The date your subscription ends.
" }, "Currency":{ "shape":"CurrencyCode", "documentation":"The currency of the subscription price. Currently only USD is supported.
The amount you are billed each month in the subscription period.
" }, "UpfrontPrice":{ "shape":"NullableDouble", "documentation":"The amount billed when the subscription is created. This is a one-time charge.
" } }, "documentation":"Provides information about your Amazon Web Services Outposts subscriptions.
" }, "SubscriptionList":{ "type":"list", "member":{"shape":"Subscription"} }, "SubscriptionPricingDetails":{ "type":"structure", "members":{ "PaymentOption":{ "shape":"PaymentOption", "documentation":"The payment option.
" }, "PaymentTerm":{ "shape":"PaymentTerm", "documentation":"The payment term.
" }, "UpfrontPrice":{ "shape":"NullableFloat", "documentation":"The upfront price.
" }, "MonthlyRecurringPrice":{ "shape":"NullableFloat", "documentation":"The monthly recurring price.
" }, "Currency":{ "shape":"CurrencyCode", "documentation":"The currency of the price. Currently only USD is supported.
The pricing details for a subscription.
" }, "SubscriptionStatus":{ "type":"string", "enum":[ "ACTIVE", "PENDING", "INACTIVE", "CANCELLED" ] }, "SubscriptionType":{ "type":"string", "enum":[ "ORIGINAL", "RENEWAL", "CAPACITY_INCREASE" ] }, "SupportedHardwareType":{ "type":"string", "enum":[ "RACK", "SERVER" ] }, "SupportedStorageEnum":{ "type":"string", "enum":[ "EBS", "S3" ] }, "SupportedStorageList":{ "type":"list", "member":{"shape":"SupportedStorageEnum"} }, "SupportedUplinkGbps":{"type":"integer"}, "SupportedUplinkGbpsListDefinition":{ "type":"list", "member":{"shape":"SupportedUplinkGbps"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"TagMap", "documentation":"The tags to add to the resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "pattern":"^[\\S \\n]+$" }, "TaskActionOnBlockingInstances":{ "type":"string", "enum":[ "WAIT_FOR_EVACUATION", "FAIL_TASK" ] }, "Token":{ "type":"string", "documentation":"The pagination token.
", "max":2048, "min":1, "pattern":"^(\\d+)##(\\S+)$" }, "TrackingId":{ "type":"string", "max":42, "min":6, "pattern":"^[a-zA-Z0-9]+$" }, "UnderlayIpAddress":{ "type":"string", "max":15, "min":7, "pattern":"^([0-9]{1,3}\\.){3}[0-9]{1,3}$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateOutpostInput":{ "type":"structure", "required":["OutpostId"], "members":{ "OutpostId":{ "shape":"OutpostId", "documentation":"The ID or ARN of the Outpost.
", "location":"uri", "locationName":"OutpostId" }, "Name":{"shape":"OutpostName"}, "Description":{"shape":"OutpostDescription"}, "SupportedHardwareType":{ "shape":"SupportedHardwareType", "documentation":"The type of hardware for this Outpost.
" } } }, "UpdateOutpostOutput":{ "type":"structure", "members":{ "Outpost":{"shape":"Outpost"} } }, "UpdateQuoteInput":{ "type":"structure", "required":["QuoteIdentifier"], "members":{ "QuoteIdentifier":{ "shape":"QuoteIdentifier", "documentation":"The ID of the quote.
", "location":"uri", "locationName":"QuoteIdentifier" }, "OutpostIdentifier":{ "shape":"OutpostIdentifierOrEmpty", "documentation":"The ID or ARN of the Outpost to associate with the quote. Specify an empty string to remove the Outpost association.
" }, "CountryCode":{ "shape":"CountryCode", "documentation":"The country code for the Outpost site location.
" }, "RequestedCapacities":{ "shape":"QuoteCapacityList", "documentation":"The updated capacity requirements for the quote.
" }, "RequestedConstraints":{ "shape":"QuoteConstraintList", "documentation":"The updated physical constraints for the quote.
" }, "RequestedPaymentOptions":{ "shape":"PaymentOptionList", "documentation":"The updated payment options to include in the quote pricing.
" }, "RequestedPaymentTerms":{ "shape":"PaymentTermList", "documentation":"The updated payment terms to include in the quote pricing.
" }, "Description":{ "shape":"QuoteDescription", "documentation":"A description for the quote.
" } } }, "UpdateQuoteOutput":{ "type":"structure", "members":{ "Quote":{ "shape":"Quote", "documentation":"Information about the updated quote.
" } } }, "UpdateSiteAddressInput":{ "type":"structure", "required":[ "SiteId", "AddressType", "Address" ], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" }, "AddressType":{ "shape":"AddressType", "documentation":"The type of the address.
" }, "Address":{ "shape":"Address", "documentation":"The address for the site.
" } } }, "UpdateSiteAddressOutput":{ "type":"structure", "members":{ "AddressType":{ "shape":"AddressType", "documentation":"The type of the address.
" }, "Address":{ "shape":"Address", "documentation":"Information about an address.
" } } }, "UpdateSiteInput":{ "type":"structure", "required":["SiteId"], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" }, "Name":{"shape":"SiteName"}, "Description":{"shape":"SiteDescription"}, "Notes":{ "shape":"SiteNotes", "documentation":"Notes about a site.
" } } }, "UpdateSiteOutput":{ "type":"structure", "members":{ "Site":{"shape":"Site"} } }, "UpdateSiteRackPhysicalPropertiesInput":{ "type":"structure", "required":["SiteId"], "members":{ "SiteId":{ "shape":"SiteId", "documentation":"The ID or the Amazon Resource Name (ARN) of the site.
", "location":"uri", "locationName":"SiteId" }, "PowerDrawKva":{ "shape":"PowerDrawKva", "documentation":"The power draw, in kVA, available at the hardware placement position for the rack.
" }, "PowerPhase":{ "shape":"PowerPhase", "documentation":"The power option that you can provide for hardware.
Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz
Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz
The power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector.
Single-phase AC feed
L6-30P – (common in US); 30A; single phase
IEC309 (blue) – P+N+E, 6hr; 32 A; single phase
Three-phase AC feed
AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase
AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase
CS8365C – (common in US); 3P+E, 50A; three phase
Indicates whether the power feed comes above or below the rack.
" }, "UplinkGbps":{ "shape":"UplinkGbps", "documentation":"The uplink speed the rack should support for the connection to the Region.
" }, "UplinkCount":{ "shape":"UplinkCount", "documentation":"Racks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount.
1Gbps - Uplinks available: 1, 2, 4, 6, 8
10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
40 and 100 Gbps- Uplinks available: 1, 2, 4
The type of fiber that you will use to attach the Outpost to your network.
" }, "OpticalStandard":{ "shape":"OpticalStandard", "documentation":"The type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
OPTIC_10GBASE_SR: 10GBASE-SR
OPTIC_10GBASE_IR: 10GBASE-IR
OPTIC_10GBASE_LR: 10GBASE-LR
OPTIC_40GBASE_SR: 40GBASE-SR
OPTIC_40GBASE_ESR: 40GBASE-ESR
OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L)
OPTIC_40GBASE_LR4: 40GBASE-LR4
OPTIC_100GBASE_SR4: 100GBASE-SR4
OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4
OPTIC_100GBASE_LR4: 100GBASE-LR4
OPTIC_100G_PSM4_MSA: 100G PSM4 MSA
OPTIC_1000BASE_LX: 1000Base-LX
OPTIC_1000BASE_SX : 1000Base-SX
The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.
A parameter is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "WireGuardPublicKey":{ "type":"string", "max":44, "min":44, "pattern":"^[a-zA-Z0-9/+]{43}=$" }, "outpostListDefinition":{ "type":"list", "member":{"shape":"Outpost"}, "documentation":"Information about the Outposts.
" }, "siteListDefinition":{ "type":"list", "member":{"shape":"Site"}, "documentation":"Information about the sites.
" } }, "documentation":"Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.
" }