# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CancelCapacityTask](API_CancelCapacityTask.md) 
+  [CancelOrder](API_CancelOrder.md) 
+  [CreateOrder](API_CreateOrder.md) 
+  [CreateOutpost](API_CreateOutpost.md) 
+  [CreateSite](API_CreateSite.md) 
+  [DeleteOutpost](API_DeleteOutpost.md) 
+  [DeleteSite](API_DeleteSite.md) 
+  [GetCapacityTask](API_GetCapacityTask.md) 
+  [GetCatalogItem](API_GetCatalogItem.md) 
+  [GetConnection](API_GetConnection.md) 
+  [GetOrder](API_GetOrder.md) 
+  [GetOutpost](API_GetOutpost.md) 
+  [GetOutpostBillingInformation](API_GetOutpostBillingInformation.md) 
+  [GetOutpostInstanceTypes](API_GetOutpostInstanceTypes.md) 
+  [GetOutpostSupportedInstanceTypes](API_GetOutpostSupportedInstanceTypes.md) 
+  [GetSite](API_GetSite.md) 
+  [GetSiteAddress](API_GetSiteAddress.md) 
+  [ListAssetInstances](API_ListAssetInstances.md) 
+  [ListAssets](API_ListAssets.md) 
+  [ListBlockingInstancesForCapacityTask](API_ListBlockingInstancesForCapacityTask.md) 
+  [ListCapacityTasks](API_ListCapacityTasks.md) 
+  [ListCatalogItems](API_ListCatalogItems.md) 
+  [ListOrders](API_ListOrders.md) 
+  [ListOutposts](API_ListOutposts.md) 
+  [ListSites](API_ListSites.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartCapacityTask](API_StartCapacityTask.md) 
+  [StartConnection](API_StartConnection.md) 
+  [StartOutpostDecommission](API_StartOutpostDecommission.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateOutpost](API_UpdateOutpost.md) 
+  [UpdateSite](API_UpdateSite.md) 
+  [UpdateSiteAddress](API_UpdateSiteAddress.md) 
+  [UpdateSiteRackPhysicalProperties](API_UpdateSiteRackPhysicalProperties.md) 

# CancelCapacityTask
<a name="API_CancelCapacityTask"></a>

Cancels the capacity task.

## Request Syntax
<a name="API_CancelCapacityTask_RequestSyntax"></a>

```
POST /outposts/OutpostId/capacity/CapacityTaskId HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelCapacityTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CapacityTaskId](#API_CancelCapacityTask_RequestSyntax) **   <a name="outposts-CancelCapacityTask-request-uri-CapacityTaskId"></a>
ID of the capacity task that you want to cancel.  
Length Constraints: Fixed length of 21.  
Pattern: `^cap-[a-f0-9]{17}$`   
Required: Yes

 ** [OutpostId](#API_CancelCapacityTask_RequestSyntax) **   <a name="outposts-CancelCapacityTask-request-uri-OutpostIdentifier"></a>
ID or ARN of the Outpost associated with the capacity task that you want to cancel.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_CancelCapacityTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelCapacityTask_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelCapacityTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelCapacityTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_CancelCapacityTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CancelCapacityTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CancelCapacityTask) 

# CancelOrder
<a name="API_CancelOrder"></a>

Cancels the specified order for an Outpost.

## Request Syntax
<a name="API_CancelOrder_RequestSyntax"></a>

```
POST /orders/OrderId/cancel HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelOrder_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OrderId](#API_CancelOrder_RequestSyntax) **   <a name="outposts-CancelOrder-request-uri-OrderId"></a>
 The ID of the order.   
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_CancelOrder_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelOrder_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelOrder_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelOrder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_CancelOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CancelOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CancelOrder) 

# CreateOrder
<a name="API_CreateOrder"></a>

Creates an order for an Outpost.

## Request Syntax
<a name="API_CreateOrder_RequestSyntax"></a>

```
POST /orders HTTP/1.1
Content-type: application/json

{
   "LineItems": [ 
      { 
         "CatalogItemId": "string",
         "Quantity": number
      }
   ],
   "OutpostIdentifier": "string",
   "PaymentOption": "string",
   "PaymentTerm": "string"
}
```

## URI Request Parameters
<a name="API_CreateOrder_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateOrder_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [LineItems](#API_CreateOrder_RequestSyntax) **   <a name="outposts-CreateOrder-request-LineItems"></a>
The line items that make up the order.  
Type: Array of [LineItemRequest](API_LineItemRequest.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: No

 ** [OutpostIdentifier](#API_CreateOrder_RequestSyntax) **   <a name="outposts-CreateOrder-request-OutpostIdentifier"></a>
 The ID or the Amazon Resource Name (ARN) of the Outpost.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

 ** [PaymentOption](#API_CreateOrder_RequestSyntax) **   <a name="outposts-CreateOrder-request-PaymentOption"></a>
The payment option.  
Type: String  
Valid Values: `ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT`   
Required: Yes

 ** [PaymentTerm](#API_CreateOrder_RequestSyntax) **   <a name="outposts-CreateOrder-request-PaymentTerm"></a>
The payment terms.  
Type: String  
Valid Values: `THREE_YEARS | ONE_YEAR | FIVE_YEARS`   
Required: No

## Response Syntax
<a name="API_CreateOrder_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Order": { 
      "LineItems": [ 
         { 
            "AssetInformationList": [ 
               { 
                  "AssetId": "string",
                  "MacAddressList": [ "string" ]
               }
            ],
            "CatalogItemId": "string",
            "LineItemId": "string",
            "PreviousLineItemId": "string",
            "PreviousOrderId": "string",
            "Quantity": number,
            "ShipmentInformation": { 
               "ShipmentCarrier": "string",
               "ShipmentTrackingNumber": "string"
            },
            "Status": "string"
         }
      ],
      "OrderFulfilledDate": number,
      "OrderId": "string",
      "OrderSubmissionDate": number,
      "OrderType": "string",
      "OutpostId": "string",
      "PaymentOption": "string",
      "PaymentTerm": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_CreateOrder_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Order](#API_CreateOrder_ResponseSyntax) **   <a name="outposts-CreateOrder-response-Order"></a>
Information about this order.  
Type: [Order](API_Order.md) object

## Errors
<a name="API_CreateOrder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded a service quota.  
HTTP Status Code: 402

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_CreateOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CreateOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CreateOrder) 

# CreateOutpost
<a name="API_CreateOutpost"></a>

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

## Request Syntax
<a name="API_CreateOutpost_RequestSyntax"></a>

```
POST /outposts HTTP/1.1
Content-type: application/json

{
   "AvailabilityZone": "string",
   "AvailabilityZoneId": "string",
   "Description": "string",
   "Name": "string",
   "SiteId": "string",
   "SupportedHardwareType": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateOutpost_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateOutpost_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-AvailabilityZone"></a>
The Availability Zone.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$`   
Required: No

 ** [AvailabilityZoneId](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-AvailabilityZoneId"></a>
The ID of the Availability Zone.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z]+\d-[a-zA-Z]+\d$`   
Required: No

 ** [Description](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-Description"></a>
The description of the Outpost.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `^[\S ]*$`   
Required: No

 ** [Name](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-Name"></a>
The name of the Outpost.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\S ]+$`   
Required: Yes

 ** [SiteId](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

 ** [SupportedHardwareType](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-SupportedHardwareType"></a>
 The type of hardware for this Outpost.   
Type: String  
Valid Values: `RACK | SERVER`   
Required: No

 ** [Tags](#API_CreateOutpost_RequestSyntax) **   <a name="outposts-CreateOutpost-request-Tags"></a>
The tags to apply to the Outpost.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[\S \n]+$`   
Required: No

## Response Syntax
<a name="API_CreateOutpost_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Outpost": { 
      "AvailabilityZone": "string",
      "AvailabilityZoneId": "string",
      "Description": "string",
      "LifeCycleStatus": "string",
      "Name": "string",
      "OutpostArn": "string",
      "OutpostId": "string",
      "OwnerId": "string",
      "SiteArn": "string",
      "SiteId": "string",
      "SupportedHardwareType": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_CreateOutpost_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Outpost](#API_CreateOutpost_ResponseSyntax) **   <a name="outposts-CreateOutpost-response-Outpost"></a>
Information about an Outpost.  
Type: [Outpost](API_Outpost.md) object

## Errors
<a name="API_CreateOutpost_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You have exceeded a service quota.  
HTTP Status Code: 402

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_CreateOutpost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CreateOutpost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CreateOutpost) 

# CreateSite
<a name="API_CreateSite"></a>

 Creates a site for an Outpost. 

## Request Syntax
<a name="API_CreateSite_RequestSyntax"></a>

```
POST /sites HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Notes": "string",
   "OperatingAddress": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "RackPhysicalProperties": { 
      "FiberOpticCableType": "string",
      "MaximumSupportedWeightLbs": "string",
      "OpticalStandard": "string",
      "PowerConnector": "string",
      "PowerDrawKva": "string",
      "PowerFeedDrop": "string",
      "PowerPhase": "string",
      "UplinkCount": "string",
      "UplinkGbps": "string"
   },
   "ShippingAddress": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateSite_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateSite_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-Description"></a>
The description of the site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1001.  
Pattern: `^[\S ]+$`   
Required: No

 ** [Name](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-Name"></a>
The name of the site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^[\S ]+$`   
Required: Yes

 ** [Notes](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-Notes"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^[\S \n]+$`   
Required: No

 ** [OperatingAddress](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-OperatingAddress"></a>
 The location to install and power on the hardware. This address might be different from the shipping address.   
Type: [Address](API_Address.md) object  
Required: No

 ** [RackPhysicalProperties](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-RackPhysicalProperties"></a>
 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](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) in the AWS Outposts User Guide.   
Type: [RackPhysicalProperties](API_RackPhysicalProperties.md) object  
Required: No

 ** [ShippingAddress](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-ShippingAddress"></a>
 The location to ship the hardware. This address might be different from the operating address.   
Type: [Address](API_Address.md) object  
Required: No

 ** [Tags](#API_CreateSite_RequestSyntax) **   <a name="outposts-CreateSite-request-Tags"></a>
 The tags to apply to a site.   
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[\S \n]+$`   
Required: No

## Response Syntax
<a name="API_CreateSite_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "AccountId": "string",
      "Description": "string",
      "Name": "string",
      "Notes": "string",
      "OperatingAddressCity": "string",
      "OperatingAddressCountryCode": "string",
      "OperatingAddressStateOrRegion": "string",
      "RackPhysicalProperties": { 
         "FiberOpticCableType": "string",
         "MaximumSupportedWeightLbs": "string",
         "OpticalStandard": "string",
         "PowerConnector": "string",
         "PowerDrawKva": "string",
         "PowerFeedDrop": "string",
         "PowerPhase": "string",
         "UplinkCount": "string",
         "UplinkGbps": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_CreateSite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Site](#API_CreateSite_ResponseSyntax) **   <a name="outposts-CreateSite-response-Site"></a>
Information about a site.  
Type: [Site](API_Site.md) object

## Errors
<a name="API_CreateSite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
You have exceeded a service quota.  
HTTP Status Code: 402

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/CreateSite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/CreateSite) 

# DeleteOutpost
<a name="API_DeleteOutpost"></a>

Deletes the specified Outpost.

## Request Syntax
<a name="API_DeleteOutpost_RequestSyntax"></a>

```
DELETE /outposts/OutpostId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteOutpost_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OutpostId](#API_DeleteOutpost_RequestSyntax) **   <a name="outposts-DeleteOutpost-request-uri-OutpostId"></a>
 The ID or ARN of the Outpost.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `OutpostId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_DeleteOutpost_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteOutpost_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteOutpost_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteOutpost_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteOutpost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/DeleteOutpost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/DeleteOutpost) 

# DeleteSite
<a name="API_DeleteSite"></a>

Deletes the specified site.

## Request Syntax
<a name="API_DeleteSite_RequestSyntax"></a>

```
DELETE /sites/SiteId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSite_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SiteId](#API_DeleteSite_RequestSyntax) **   <a name="outposts-DeleteSite-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_DeleteSite_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSite_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteSite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteSite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/DeleteSite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/DeleteSite) 

# GetCapacityTask
<a name="API_GetCapacityTask"></a>

Gets details of the specified capacity task.

## Request Syntax
<a name="API_GetCapacityTask_RequestSyntax"></a>

```
GET /outposts/OutpostId/capacity/CapacityTaskId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetCapacityTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CapacityTaskId](#API_GetCapacityTask_RequestSyntax) **   <a name="outposts-GetCapacityTask-request-uri-CapacityTaskId"></a>
ID of the capacity task.  
Length Constraints: Fixed length of 21.  
Pattern: `^cap-[a-f0-9]{17}$`   
Required: Yes

 ** [OutpostId](#API_GetCapacityTask_RequestSyntax) **   <a name="outposts-GetCapacityTask-request-uri-OutpostIdentifier"></a>
ID or ARN of the Outpost associated with the specified capacity task.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetCapacityTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetCapacityTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssetId": "string",
   "CapacityTaskId": "string",
   "CapacityTaskStatus": "string",
   "CompletionDate": number,
   "CreationDate": number,
   "DryRun": boolean,
   "Failed": { 
      "Reason": "string",
      "Type": "string"
   },
   "InstancesToExclude": { 
      "AccountIds": [ "string" ],
      "Instances": [ "string" ],
      "Services": [ "string" ]
   },
   "LastModifiedDate": number,
   "OrderId": "string",
   "OutpostId": "string",
   "RequestedInstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "TaskActionOnBlockingInstances": "string"
}
```

## Response Elements
<a name="API_GetCapacityTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssetId](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-AssetId"></a>
The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\w+)$` 

 ** [CapacityTaskId](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-CapacityTaskId"></a>
ID of the capacity task.  
Type: String  
Length Constraints: Fixed length of 21.  
Pattern: `^cap-[a-f0-9]{17}$` 

 ** [CapacityTaskStatus](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-CapacityTaskStatus"></a>
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 AWS 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.
Type: String  
Valid Values: `REQUESTED | IN_PROGRESS | FAILED | COMPLETED | WAITING_FOR_EVACUATION | CANCELLATION_IN_PROGRESS | CANCELLED` 

 ** [CompletionDate](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-CompletionDate"></a>
The date the capacity task ran successfully.  
Type: Timestamp

 ** [CreationDate](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-CreationDate"></a>
The date the capacity task was created.  
Type: Timestamp

 ** [DryRun](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-DryRun"></a>
Performs a dry run to determine if you are above or below instance capacity.  
Type: Boolean

 ** [Failed](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-Failed"></a>
Reason why the capacity task failed.  
Type: [CapacityTaskFailure](API_CapacityTaskFailure.md) object

 ** [InstancesToExclude](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-InstancesToExclude"></a>
Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.  
Type: [InstancesToExclude](API_InstancesToExclude.md) object

 ** [LastModifiedDate](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-LastModifiedDate"></a>
The date the capacity task was last modified.  
Type: Timestamp

 ** [OrderId](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-OrderId"></a>
ID of the AWS Outposts order associated with the specified capacity task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$` 

 ** [OutpostId](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-OutpostId"></a>
ID of the Outpost associated with the specified capacity task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$` 

 ** [RequestedInstancePools](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-RequestedInstancePools"></a>
List of instance pools requested in the capacity task.  
Type: Array of [InstanceTypeCapacity](API_InstanceTypeCapacity.md) objects

 ** [TaskActionOnBlockingInstances](#API_GetCapacityTask_ResponseSyntax) **   <a name="outposts-GetCapacityTask-response-TaskActionOnBlockingInstances"></a>
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.
Type: String  
Valid Values: `WAIT_FOR_EVACUATION | FAIL_TASK` 

## Errors
<a name="API_GetCapacityTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetCapacityTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetCapacityTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetCapacityTask) 

# GetCatalogItem
<a name="API_GetCatalogItem"></a>

Gets information about the specified catalog item.

## Request Syntax
<a name="API_GetCatalogItem_RequestSyntax"></a>

```
GET /catalog/item/CatalogItemId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetCatalogItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CatalogItemId](#API_GetCatalogItem_RequestSyntax) **   <a name="outposts-GetCatalogItem-request-uri-CatalogItemId"></a>
The ID of the catalog item.  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `OR-[A-Z0-9]{7}`   
Required: Yes

## Request Body
<a name="API_GetCatalogItem_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetCatalogItem_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CatalogItem": { 
      "CatalogItemId": "string",
      "EC2Capacities": [ 
         { 
            "Family": "string",
            "MaxSize": "string",
            "Quantity": "string"
         }
      ],
      "ItemStatus": "string",
      "PowerKva": number,
      "SupportedStorage": [ "string" ],
      "SupportedUplinkGbps": [ number ],
      "WeightLbs": number
   }
}
```

## Response Elements
<a name="API_GetCatalogItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CatalogItem](#API_GetCatalogItem_ResponseSyntax) **   <a name="outposts-GetCatalogItem-response-CatalogItem"></a>
Information about this catalog item.  
Type: [CatalogItem](API_CatalogItem.md) object

## Errors
<a name="API_GetCatalogItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetCatalogItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetCatalogItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetCatalogItem) 

# GetConnection
<a name="API_GetConnection"></a>

**Note**  
 AWS uses this action to install Outpost servers.

 Gets information about the specified connection. 

 Use CloudTrail to monitor this action or AWS managed policy for AWS Outposts to secure it. For more information, see [AWS managed policies for AWS Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) and [ Logging AWS Outposts API calls with AWS CloudTrail](https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) in the * AWS Outposts User Guide*. 

## Request Syntax
<a name="API_GetConnection_RequestSyntax"></a>

```
GET /connections/ConnectionId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionId](#API_GetConnection_RequestSyntax) **   <a name="outposts-GetConnection-request-uri-ConnectionId"></a>
 The ID of the connection.   
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[a-zA-Z0-9+/=]{1,1024}$`   
Required: Yes

## Request Body
<a name="API_GetConnection_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConnection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ConnectionDetails": { 
      "AllowedIps": [ "string" ],
      "ClientPublicKey": "string",
      "ClientTunnelAddress": "string",
      "ServerEndpoint": "string",
      "ServerPublicKey": "string",
      "ServerTunnelAddress": "string"
   },
   "ConnectionId": "string"
}
```

## Response Elements
<a name="API_GetConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionDetails](#API_GetConnection_ResponseSyntax) **   <a name="outposts-GetConnection-response-ConnectionDetails"></a>
 Information about the connection.   
Type: [ConnectionDetails](API_ConnectionDetails.md) object

 ** [ConnectionId](#API_GetConnection_ResponseSyntax) **   <a name="outposts-GetConnection-response-ConnectionId"></a>
 The ID of the connection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[a-zA-Z0-9+/=]{1,1024}$` 

## Errors
<a name="API_GetConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetConnection) 

# GetOrder
<a name="API_GetOrder"></a>

Gets information about the specified order.

## Request Syntax
<a name="API_GetOrder_RequestSyntax"></a>

```
GET /orders/OrderId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetOrder_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OrderId](#API_GetOrder_RequestSyntax) **   <a name="outposts-GetOrder-request-uri-OrderId"></a>
The ID of the order.  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetOrder_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetOrder_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Order": { 
      "LineItems": [ 
         { 
            "AssetInformationList": [ 
               { 
                  "AssetId": "string",
                  "MacAddressList": [ "string" ]
               }
            ],
            "CatalogItemId": "string",
            "LineItemId": "string",
            "PreviousLineItemId": "string",
            "PreviousOrderId": "string",
            "Quantity": number,
            "ShipmentInformation": { 
               "ShipmentCarrier": "string",
               "ShipmentTrackingNumber": "string"
            },
            "Status": "string"
         }
      ],
      "OrderFulfilledDate": number,
      "OrderId": "string",
      "OrderSubmissionDate": number,
      "OrderType": "string",
      "OutpostId": "string",
      "PaymentOption": "string",
      "PaymentTerm": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_GetOrder_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Order](#API_GetOrder_ResponseSyntax) **   <a name="outposts-GetOrder-response-Order"></a>
Information about an order.  
Type: [Order](API_Order.md) object

## Errors
<a name="API_GetOrder_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOrder) 

# GetOutpost
<a name="API_GetOutpost"></a>

Gets information about the specified Outpost.

## Request Syntax
<a name="API_GetOutpost_RequestSyntax"></a>

```
GET /outposts/OutpostId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetOutpost_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OutpostId](#API_GetOutpost_RequestSyntax) **   <a name="outposts-GetOutpost-request-uri-OutpostId"></a>
The ID or ARN of the Outpost.  
Despite the parameter name, you can make the request with an ARN. The parameter name is `OutpostId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetOutpost_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetOutpost_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Outpost": { 
      "AvailabilityZone": "string",
      "AvailabilityZoneId": "string",
      "Description": "string",
      "LifeCycleStatus": "string",
      "Name": "string",
      "OutpostArn": "string",
      "OutpostId": "string",
      "OwnerId": "string",
      "SiteArn": "string",
      "SiteId": "string",
      "SupportedHardwareType": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_GetOutpost_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Outpost](#API_GetOutpost_ResponseSyntax) **   <a name="outposts-GetOutpost-response-Outpost"></a>
Information about an Outpost.  
Type: [Outpost](API_Outpost.md) object

## Errors
<a name="API_GetOutpost_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetOutpost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutpost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpost) 

# GetOutpostBillingInformation
<a name="API_GetOutpostBillingInformation"></a>

Gets current and historical billing information about the specified Outpost.

## Request Syntax
<a name="API_GetOutpostBillingInformation_RequestSyntax"></a>

```
GET /outpost/OutpostIdentifier/billing-information?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetOutpostBillingInformation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_GetOutpostBillingInformation_RequestSyntax) **   <a name="outposts-GetOutpostBillingInformation-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_GetOutpostBillingInformation_RequestSyntax) **   <a name="outposts-GetOutpostBillingInformation-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostIdentifier](#API_GetOutpostBillingInformation_RequestSyntax) **   <a name="outposts-GetOutpostBillingInformation-request-uri-OutpostIdentifier"></a>
The ID or ARN of the Outpost.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetOutpostBillingInformation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetOutpostBillingInformation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContractEndDate": "string",
   "NextToken": "string",
   "Subscriptions": [ 
      { 
         "BeginDate": number,
         "EndDate": number,
         "MonthlyRecurringPrice": number,
         "OrderIds": [ "string" ],
         "SubscriptionId": "string",
         "SubscriptionStatus": "string",
         "SubscriptionType": "string",
         "UpfrontPrice": number
      }
   ]
}
```

## Response Elements
<a name="API_GetOutpostBillingInformation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContractEndDate](#API_GetOutpostBillingInformation_ResponseSyntax) **   <a name="outposts-GetOutpostBillingInformation-response-ContractEndDate"></a>
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 AWS Outposts ends. Failing to complete these steps at least 5 business days before the current term ends might result in unanticipated charges.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^[\S \n]+$` 

 ** [NextToken](#API_GetOutpostBillingInformation_ResponseSyntax) **   <a name="outposts-GetOutpostBillingInformation-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [Subscriptions](#API_GetOutpostBillingInformation_ResponseSyntax) **   <a name="outposts-GetOutpostBillingInformation-response-Subscriptions"></a>
The subscription details for the specified Outpost.  
Type: Array of [Subscription](API_Subscription.md) objects

## Errors
<a name="API_GetOutpostBillingInformation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

## Examples
<a name="API_GetOutpostBillingInformation_Examples"></a>

### Example
<a name="API_GetOutpostBillingInformation_Example_1"></a>

This example displays information about the subscription for the specified Outpost.

#### Sample Request
<a name="API_GetOutpostBillingInformation_Example_1_Request"></a>

```
aws outposts get-outpost-billing-information --outpost-identifier op-1234567890example"
```

#### Sample Response
<a name="API_GetOutpostBillingInformation_Example_1_Response"></a>

```
{
  "Subscriptions": [
    {
      "SubscriptionId": "1234567890",
      "SubscriptionType": "ORIGINAL",
      "SubscriptionStatus": "ACTIVE",
      "OrderIds": [
        "oo-00000000000000000"
      ],
      "BeginDate": "Tue Jul 18 16:09:01 UTC 2024",
      "EndDate": "Fri Jul 17 16:09:01 UTC 2026",
      "Currency": "USD",
      "MonthlyRecurringPrice": 100.12,
      "UpfrontPrice": 1000.10
    }
  ],
  "ContractEndDate": "Fri Jul 17 16:09:01 UTC 2026"
}
```

## See Also
<a name="API_GetOutpostBillingInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutpostBillingInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpostBillingInformation) 

# GetOutpostInstanceTypes
<a name="API_GetOutpostInstanceTypes"></a>

Gets the instance types for the specified Outpost.

## Request Syntax
<a name="API_GetOutpostInstanceTypes_RequestSyntax"></a>

```
GET /outposts/OutpostId/instanceTypes?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetOutpostInstanceTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_GetOutpostInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostInstanceTypes-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_GetOutpostInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostInstanceTypes-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostId](#API_GetOutpostInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostInstanceTypes-request-uri-OutpostId"></a>
 The ID or ARN of the Outpost.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `OutpostId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetOutpostInstanceTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetOutpostInstanceTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InstanceTypes": [ 
      { 
         "InstanceType": "string",
         "VCPUs": number
      }
   ],
   "NextToken": "string",
   "OutpostArn": "string",
   "OutpostId": "string"
}
```

## Response Elements
<a name="API_GetOutpostInstanceTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceTypes](#API_GetOutpostInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostInstanceTypes-response-InstanceTypes"></a>
Information about the instance types.  
Type: Array of [InstanceTypeItem](API_InstanceTypeItem.md) objects

 ** [NextToken](#API_GetOutpostInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostInstanceTypes-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostArn](#API_GetOutpostInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostInstanceTypes-response-OutpostArn"></a>
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$` 

 ** [OutpostId](#API_GetOutpostInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostInstanceTypes-response-OutpostId"></a>
 The ID of the Outpost.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `OutpostId` for backward compatibility.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$` 

## Errors
<a name="API_GetOutpostInstanceTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetOutpostInstanceTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutpostInstanceTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpostInstanceTypes) 

# GetOutpostSupportedInstanceTypes
<a name="API_GetOutpostSupportedInstanceTypes"></a>

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.

## Request Syntax
<a name="API_GetOutpostSupportedInstanceTypes_RequestSyntax"></a>

```
GET /outposts/OutpostId/supportedInstanceTypes?AssetId=AssetId&MaxResults=MaxResults&NextToken=NextToken&OrderId=OrderId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetOutpostSupportedInstanceTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssetId](#API_GetOutpostSupportedInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-request-uri-AssetId"></a>
The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.  
Length Constraints: Fixed length of 10.  
Pattern: `\d{10}` 

 ** [MaxResults](#API_GetOutpostSupportedInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_GetOutpostSupportedInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OrderId](#API_GetOutpostSupportedInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-request-uri-OrderId"></a>
The ID for the AWS Outposts order.  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$` 

 ** [OutpostId](#API_GetOutpostSupportedInstanceTypes_RequestSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-request-uri-OutpostIdentifier"></a>
The ID or ARN of the Outpost.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_GetOutpostSupportedInstanceTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetOutpostSupportedInstanceTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InstanceTypes": [ 
      { 
         "InstanceType": "string",
         "VCPUs": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetOutpostSupportedInstanceTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceTypes](#API_GetOutpostSupportedInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-response-InstanceTypes"></a>
Information about the instance types.  
Type: Array of [InstanceTypeItem](API_InstanceTypeItem.md) objects

 ** [NextToken](#API_GetOutpostSupportedInstanceTypes_ResponseSyntax) **   <a name="outposts-GetOutpostSupportedInstanceTypes-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_GetOutpostSupportedInstanceTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetOutpostSupportedInstanceTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetOutpostSupportedInstanceTypes) 

# GetSite
<a name="API_GetSite"></a>

Gets information about the specified Outpost site.

## Request Syntax
<a name="API_GetSite_RequestSyntax"></a>

```
GET /sites/SiteId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSite_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SiteId](#API_GetSite_RequestSyntax) **   <a name="outposts-GetSite-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_GetSite_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSite_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "AccountId": "string",
      "Description": "string",
      "Name": "string",
      "Notes": "string",
      "OperatingAddressCity": "string",
      "OperatingAddressCountryCode": "string",
      "OperatingAddressStateOrRegion": "string",
      "RackPhysicalProperties": { 
         "FiberOpticCableType": "string",
         "MaximumSupportedWeightLbs": "string",
         "OpticalStandard": "string",
         "PowerConnector": "string",
         "PowerDrawKva": "string",
         "PowerFeedDrop": "string",
         "PowerPhase": "string",
         "UplinkCount": "string",
         "UplinkGbps": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_GetSite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Site](#API_GetSite_ResponseSyntax) **   <a name="outposts-GetSite-response-Site"></a>
Information about a site.  
Type: [Site](API_Site.md) object

## Errors
<a name="API_GetSite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetSite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetSite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetSite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetSite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetSite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetSite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetSite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetSite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetSite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetSite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetSite) 

# GetSiteAddress
<a name="API_GetSiteAddress"></a>

 Gets the site address of the specified site. 

## Request Syntax
<a name="API_GetSiteAddress_RequestSyntax"></a>

```
GET /sites/SiteId/address?AddressType=AddressType HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSiteAddress_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AddressType](#API_GetSiteAddress_RequestSyntax) **   <a name="outposts-GetSiteAddress-request-uri-AddressType"></a>
The type of the address you request.   
Valid Values: `SHIPPING_ADDRESS | OPERATING_ADDRESS`   
Required: Yes

 ** [SiteId](#API_GetSiteAddress_RequestSyntax) **   <a name="outposts-GetSiteAddress-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_GetSiteAddress_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSiteAddress_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Address": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "AddressType": "string",
   "SiteId": "string"
}
```

## Response Elements
<a name="API_GetSiteAddress_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Address](#API_GetSiteAddress_ResponseSyntax) **   <a name="outposts-GetSiteAddress-response-Address"></a>
 Information about the address.   
Type: [Address](API_Address.md) object

 ** [AddressType](#API_GetSiteAddress_ResponseSyntax) **   <a name="outposts-GetSiteAddress-response-AddressType"></a>
The type of the address you receive.   
Type: String  
Valid Values: `SHIPPING_ADDRESS | OPERATING_ADDRESS` 

 ** [SiteId](#API_GetSiteAddress_ResponseSyntax) **   <a name="outposts-GetSiteAddress-response-SiteId"></a>
The ID of the site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$` 

## Errors
<a name="API_GetSiteAddress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_GetSiteAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/GetSiteAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/GetSiteAddress) 

# ListAssetInstances
<a name="API_ListAssetInstances"></a>

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.

## Request Syntax
<a name="API_ListAssetInstances_RequestSyntax"></a>

```
GET /outposts/OutpostId/assetInstances?AccountIdFilter=AccountIdFilter&AssetIdFilter=AssetIdFilter&AwsServiceFilter=AwsServiceFilter&InstanceTypeFilter=InstanceTypeFilter&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetInstances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AccountIdFilter](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-AccountIdFilter"></a>
Filters the results by account ID.  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [AssetIdFilter](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-AssetIdFilter"></a>
Filters the results by asset ID.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\w+)$` 

 ** [AwsServiceFilter](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-AwsServiceFilter"></a>
Filters the results by AWS service.  
Valid Values: `AWS | EC2 | ELASTICACHE | ELB | RDS | ROUTE53` 

 ** [InstanceTypeFilter](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-InstanceTypeFilter"></a>
Filters the results by instance ID.  
Length Constraints: Minimum length of 3. Maximum length of 30.  
Pattern: `[a-z0-9\-\.]+` 

 ** [MaxResults](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostId](#API_ListAssetInstances_RequestSyntax) **   <a name="outposts-ListAssetInstances-request-uri-OutpostIdentifier"></a>
The ID of the Outpost.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_ListAssetInstances_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetInstances_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssetInstances": [ 
      { 
         "AccountId": "string",
         "AssetId": "string",
         "AwsServiceName": "string",
         "InstanceId": "string",
         "InstanceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssetInstances](#API_ListAssetInstances_ResponseSyntax) **   <a name="outposts-ListAssetInstances-response-AssetInstances"></a>
List of instances owned by all accounts on the Outpost. Does not include Amazon EBS or Amazon S3 instances.  
Type: Array of [AssetInstance](API_AssetInstance.md) objects

 ** [NextToken](#API_ListAssetInstances_ResponseSyntax) **   <a name="outposts-ListAssetInstances-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_ListAssetInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListAssetInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListAssetInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListAssetInstances) 

# ListAssets
<a name="API_ListAssets"></a>

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.

## Request Syntax
<a name="API_ListAssets_RequestSyntax"></a>

```
GET /outposts/OutpostId/assets?HostIdFilter=HostIdFilter&MaxResults=MaxResults&NextToken=NextToken&StatusFilter=StatusFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HostIdFilter](#API_ListAssets_RequestSyntax) **   <a name="outposts-ListAssets-request-uri-HostIdFilter"></a>
Filters the results by the host ID of a Dedicated Host.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^[A-Za-z0-9-]*$` 

 ** [MaxResults](#API_ListAssets_RequestSyntax) **   <a name="outposts-ListAssets-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAssets_RequestSyntax) **   <a name="outposts-ListAssets-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostId](#API_ListAssets_RequestSyntax) **   <a name="outposts-ListAssets-request-uri-OutpostIdentifier"></a>
 The ID or the Amazon Resource Name (ARN) of the Outpost.   
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

 ** [StatusFilter](#API_ListAssets_RequestSyntax) **   <a name="outposts-ListAssets-request-uri-StatusFilter"></a>
Filters the results by state.  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Valid Values: `ACTIVE | RETIRING | ISOLATED` 

## Request Body
<a name="API_ListAssets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Assets": [ 
      { 
         "AssetId": "string",
         "AssetLocation": { 
            "RackElevation": number
         },
         "AssetType": "string",
         "ComputeAttributes": { 
            "HostId": "string",
            "InstanceFamilies": [ "string" ],
            "InstanceTypeCapacities": [ 
               { 
                  "Count": number,
                  "InstanceType": "string"
               }
            ],
            "MaxVcpus": number,
            "State": "string"
         },
         "RackId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAssets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Assets](#API_ListAssets_ResponseSyntax) **   <a name="outposts-ListAssets-response-Assets"></a>
Information about the hardware assets.  
Type: Array of [AssetInfo](API_AssetInfo.md) objects

 ** [NextToken](#API_ListAssets_ResponseSyntax) **   <a name="outposts-ListAssets-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_ListAssets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListAssets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListAssets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListAssets) 

# ListBlockingInstancesForCapacityTask
<a name="API_ListBlockingInstancesForCapacityTask"></a>

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.

## Request Syntax
<a name="API_ListBlockingInstancesForCapacityTask_RequestSyntax"></a>

```
GET /outposts/OutpostId/capacity/CapacityTaskId/blockingInstances?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListBlockingInstancesForCapacityTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CapacityTaskId](#API_ListBlockingInstancesForCapacityTask_RequestSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-request-uri-CapacityTaskId"></a>
The ID of the capacity task.  
Length Constraints: Fixed length of 21.  
Pattern: `^cap-[a-f0-9]{17}$`   
Required: Yes

 ** [MaxResults](#API_ListBlockingInstancesForCapacityTask_RequestSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListBlockingInstancesForCapacityTask_RequestSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostId](#API_ListBlockingInstancesForCapacityTask_RequestSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-request-uri-OutpostIdentifier"></a>
The ID or ARN of the Outpost associated with the specified capacity task.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_ListBlockingInstancesForCapacityTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListBlockingInstancesForCapacityTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BlockingInstances": [ 
      { 
         "AccountId": "string",
         "AwsServiceName": "string",
         "InstanceId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListBlockingInstancesForCapacityTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BlockingInstances](#API_ListBlockingInstancesForCapacityTask_ResponseSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-response-BlockingInstances"></a>
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.  
Type: Array of [BlockingInstance](API_BlockingInstance.md) objects

 ** [NextToken](#API_ListBlockingInstancesForCapacityTask_ResponseSyntax) **   <a name="outposts-ListBlockingInstancesForCapacityTask-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_ListBlockingInstancesForCapacityTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListBlockingInstancesForCapacityTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListBlockingInstancesForCapacityTask) 

# ListCapacityTasks
<a name="API_ListCapacityTasks"></a>

Lists the capacity tasks for your AWS 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.

## Request Syntax
<a name="API_ListCapacityTasks_RequestSyntax"></a>

```
GET /capacity/tasks?CapacityTaskStatusFilter=CapacityTaskStatusFilter&MaxResults=MaxResults&NextToken=NextToken&OutpostIdentifierFilter=OutpostIdentifierFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListCapacityTasks_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CapacityTaskStatusFilter](#API_ListCapacityTasks_RequestSyntax) **   <a name="outposts-ListCapacityTasks-request-uri-CapacityTaskStatusFilter"></a>
A list of statuses. For example, `REQUESTED` or `WAITING_FOR_EVACUATION`.  
Valid Values: `REQUESTED | IN_PROGRESS | FAILED | COMPLETED | WAITING_FOR_EVACUATION | CANCELLATION_IN_PROGRESS | CANCELLED` 

 ** [MaxResults](#API_ListCapacityTasks_RequestSyntax) **   <a name="outposts-ListCapacityTasks-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListCapacityTasks_RequestSyntax) **   <a name="outposts-ListCapacityTasks-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostIdentifierFilter](#API_ListCapacityTasks_RequestSyntax) **   <a name="outposts-ListCapacityTasks-request-uri-OutpostIdentifierFilter"></a>
Filters the results by an Outpost ID or an Outpost ARN.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$` 

## Request Body
<a name="API_ListCapacityTasks_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListCapacityTasks_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CapacityTasks": [ 
      { 
         "AssetId": "string",
         "CapacityTaskId": "string",
         "CapacityTaskStatus": "string",
         "CompletionDate": number,
         "CreationDate": number,
         "LastModifiedDate": number,
         "OrderId": "string",
         "OutpostId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCapacityTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CapacityTasks](#API_ListCapacityTasks_ResponseSyntax) **   <a name="outposts-ListCapacityTasks-response-CapacityTasks"></a>
Lists all the capacity tasks.  
Type: Array of [CapacityTaskSummary](API_CapacityTaskSummary.md) objects

 ** [NextToken](#API_ListCapacityTasks_ResponseSyntax) **   <a name="outposts-ListCapacityTasks-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_ListCapacityTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListCapacityTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListCapacityTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListCapacityTasks) 

# ListCatalogItems
<a name="API_ListCatalogItems"></a>

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.

## Request Syntax
<a name="API_ListCatalogItems_RequestSyntax"></a>

```
GET /catalog/items?EC2FamilyFilter=EC2FamilyFilter&ItemClassFilter=ItemClassFilter&MaxResults=MaxResults&NextToken=NextToken&SupportedStorageFilter=SupportedStorageFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListCatalogItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EC2FamilyFilter](#API_ListCatalogItems_RequestSyntax) **   <a name="outposts-ListCatalogItems-request-uri-EC2FamilyFilter"></a>
Filters the results by EC2 family (for example, M5).  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `[a-z0-9]+` 

 ** [ItemClassFilter](#API_ListCatalogItems_RequestSyntax) **   <a name="outposts-ListCatalogItems-request-uri-ItemClassFilter"></a>
Filters the results by item class.  
Valid Values: `RACK | SERVER` 

 ** [MaxResults](#API_ListCatalogItems_RequestSyntax) **   <a name="outposts-ListCatalogItems-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListCatalogItems_RequestSyntax) **   <a name="outposts-ListCatalogItems-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [SupportedStorageFilter](#API_ListCatalogItems_RequestSyntax) **   <a name="outposts-ListCatalogItems-request-uri-SupportedStorageFilter"></a>
Filters the results by storage option.  
Valid Values: `EBS | S3` 

## Request Body
<a name="API_ListCatalogItems_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListCatalogItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CatalogItems": [ 
      { 
         "CatalogItemId": "string",
         "EC2Capacities": [ 
            { 
               "Family": "string",
               "MaxSize": "string",
               "Quantity": "string"
            }
         ],
         "ItemStatus": "string",
         "PowerKva": number,
         "SupportedStorage": [ "string" ],
         "SupportedUplinkGbps": [ number ],
         "WeightLbs": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCatalogItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CatalogItems](#API_ListCatalogItems_ResponseSyntax) **   <a name="outposts-ListCatalogItems-response-CatalogItems"></a>
Information about the catalog items.  
Type: Array of [CatalogItem](API_CatalogItem.md) objects

 ** [NextToken](#API_ListCatalogItems_ResponseSyntax) **   <a name="outposts-ListCatalogItems-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Errors
<a name="API_ListCatalogItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListCatalogItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListCatalogItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListCatalogItems) 

# ListOrders
<a name="API_ListOrders"></a>

Lists the Outpost orders for your AWS account.

## Request Syntax
<a name="API_ListOrders_RequestSyntax"></a>

```
GET /list-orders?MaxResults=MaxResults&NextToken=NextToken&OutpostIdentifierFilter=OutpostIdentifierFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListOrders_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListOrders_RequestSyntax) **   <a name="outposts-ListOrders-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListOrders_RequestSyntax) **   <a name="outposts-ListOrders-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OutpostIdentifierFilter](#API_ListOrders_RequestSyntax) **   <a name="outposts-ListOrders-request-uri-OutpostIdentifierFilter"></a>
 The ID or the Amazon Resource Name (ARN) of the Outpost.   
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$` 

## Request Body
<a name="API_ListOrders_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListOrders_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Orders": [ 
      { 
         "LineItemCountsByStatus": { 
            "string" : number 
         },
         "OrderFulfilledDate": number,
         "OrderId": "string",
         "OrderSubmissionDate": number,
         "OrderType": "string",
         "OutpostId": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOrders_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOrders_ResponseSyntax) **   <a name="outposts-ListOrders-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [Orders](#API_ListOrders_ResponseSyntax) **   <a name="outposts-ListOrders-response-Orders"></a>
 Information about the orders.   
Type: Array of [OrderSummary](API_OrderSummary.md) objects

## Errors
<a name="API_ListOrders_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListOrders_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListOrders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListOrders) 

# ListOutposts
<a name="API_ListOutposts"></a>

Lists the Outposts for your AWS 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.

## Request Syntax
<a name="API_ListOutposts_RequestSyntax"></a>

```
GET /outposts?AvailabilityZoneFilter=AvailabilityZoneFilter&AvailabilityZoneIdFilter=AvailabilityZoneIdFilter&LifeCycleStatusFilter=LifeCycleStatusFilter&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListOutposts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AvailabilityZoneFilter](#API_ListOutposts_RequestSyntax) **   <a name="outposts-ListOutposts-request-uri-AvailabilityZoneFilter"></a>
Filters the results by Availability Zone (for example, `us-east-1a`).  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$` 

 ** [AvailabilityZoneIdFilter](#API_ListOutposts_RequestSyntax) **   <a name="outposts-ListOutposts-request-uri-AvailabilityZoneIdFilter"></a>
Filters the results by AZ ID (for example, `use1-az1`).  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z]+\d-[a-zA-Z]+\d$` 

 ** [LifeCycleStatusFilter](#API_ListOutposts_RequestSyntax) **   <a name="outposts-ListOutposts-request-uri-LifeCycleStatusFilter"></a>
Filters the results by the lifecycle status.  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `^[ A-Za-z]+$` 

 ** [MaxResults](#API_ListOutposts_RequestSyntax) **   <a name="outposts-ListOutposts-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListOutposts_RequestSyntax) **   <a name="outposts-ListOutposts-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

## Request Body
<a name="API_ListOutposts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListOutposts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Outposts": [ 
      { 
         "AvailabilityZone": "string",
         "AvailabilityZoneId": "string",
         "Description": "string",
         "LifeCycleStatus": "string",
         "Name": "string",
         "OutpostArn": "string",
         "OutpostId": "string",
         "OwnerId": "string",
         "SiteArn": "string",
         "SiteId": "string",
         "SupportedHardwareType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListOutposts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListOutposts_ResponseSyntax) **   <a name="outposts-ListOutposts-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [Outposts](#API_ListOutposts_ResponseSyntax) **   <a name="outposts-ListOutposts-response-Outposts"></a>
Information about the Outposts.  
Type: Array of [Outpost](API_Outpost.md) objects

## Errors
<a name="API_ListOutposts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListOutposts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListOutposts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListOutposts) 

# ListSites
<a name="API_ListSites"></a>

Lists the Outpost sites for your AWS 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.

## Request Syntax
<a name="API_ListSites_RequestSyntax"></a>

```
GET /sites?MaxResults=MaxResults&NextToken=NextToken&OperatingAddressCityFilter=OperatingAddressCityFilter&OperatingAddressCountryCodeFilter=OperatingAddressCountryCodeFilter&OperatingAddressStateOrRegionFilter=OperatingAddressStateOrRegionFilter HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSites_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListSites_RequestSyntax) **   <a name="outposts-ListSites-request-uri-MaxResults"></a>
The maximum page size.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListSites_RequestSyntax) **   <a name="outposts-ListSites-request-uri-NextToken"></a>
The pagination token.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [OperatingAddressCityFilter](#API_ListSites_RequestSyntax) **   <a name="outposts-ListSites-request-uri-OperatingAddressCityFilter"></a>
Filters the results by city.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^\S[\S ]*$` 

 ** [OperatingAddressCountryCodeFilter](#API_ListSites_RequestSyntax) **   <a name="outposts-ListSites-request-uri-OperatingAddressCountryCodeFilter"></a>
Filters the results by country code.  
Length Constraints: Fixed length of 2.  
Pattern: `^[A-Z]{2}$` 

 ** [OperatingAddressStateOrRegionFilter](#API_ListSites_RequestSyntax) **   <a name="outposts-ListSites-request-uri-OperatingAddressStateOrRegionFilter"></a>
Filters the results by state or region.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^\S[\S ]*$` 

## Request Body
<a name="API_ListSites_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSites_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Sites": [ 
      { 
         "AccountId": "string",
         "Description": "string",
         "Name": "string",
         "Notes": "string",
         "OperatingAddressCity": "string",
         "OperatingAddressCountryCode": "string",
         "OperatingAddressStateOrRegion": "string",
         "RackPhysicalProperties": { 
            "FiberOpticCableType": "string",
            "MaximumSupportedWeightLbs": "string",
            "OpticalStandard": "string",
            "PowerConnector": "string",
            "PowerDrawKva": "string",
            "PowerFeedDrop": "string",
            "PowerPhase": "string",
            "UplinkCount": "string",
            "UplinkGbps": "string"
         },
         "SiteArn": "string",
         "SiteId": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListSites_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListSites_ResponseSyntax) **   <a name="outposts-ListSites-response-NextToken"></a>
The pagination token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(\d+)##(\S+)$` 

 ** [Sites](#API_ListSites_ResponseSyntax) **   <a name="outposts-ListSites-response-Sites"></a>
Information about the sites.  
Type: Array of [Site](API_Site.md) objects

## Errors
<a name="API_ListSites_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListSites_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListSites) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListSites) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListSites) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListSites) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListSites) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListSites) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListSites) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListSites) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListSites) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListSites) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists the tags for the specified resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="outposts-ListTagsForResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Length Constraints: Maximum length of 1011.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="outposts-ListTagsForResource-response-Tags"></a>
The resource tags.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[\S \n]+$` 

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/ListTagsForResource) 

# StartCapacityTask
<a name="API_StartCapacityTask"></a>

Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.

## Request Syntax
<a name="API_StartCapacityTask_RequestSyntax"></a>

```
POST /outposts/OutpostId/capacity HTTP/1.1
Content-type: application/json

{
   "AssetId": "string",
   "DryRun": boolean,
   "InstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "InstancesToExclude": { 
      "AccountIds": [ "string" ],
      "Instances": [ "string" ],
      "Services": [ "string" ]
   },
   "OrderId": "string",
   "TaskActionOnBlockingInstances": "string"
}
```

## URI Request Parameters
<a name="API_StartCapacityTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OutpostId](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-uri-OutpostIdentifier"></a>
The ID or ARN of the Outposts associated with the specified capacity task.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_StartCapacityTask_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AssetId](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-AssetId"></a>
The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.  
Type: String  
Length Constraints: Fixed length of 10.  
Pattern: `\d{10}`   
Required: No

 ** [DryRun](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-DryRun"></a>
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.  
Type: Boolean  
Required: No

 ** [InstancePools](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-InstancePools"></a>
The instance pools specified in the capacity task.  
Type: Array of [InstanceTypeCapacity](API_InstanceTypeCapacity.md) objects  
Required: Yes

 ** [InstancesToExclude](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-InstancesToExclude"></a>
List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.  
Type: [InstancesToExclude](API_InstancesToExclude.md) object  
Required: No

 ** [OrderId](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-OrderId"></a>
The ID of the AWS Outposts order associated with the specified capacity task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$`   
Required: No

 ** [TaskActionOnBlockingInstances](#API_StartCapacityTask_RequestSyntax) **   <a name="outposts-StartCapacityTask-request-TaskActionOnBlockingInstances"></a>
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.
Type: String  
Valid Values: `WAIT_FOR_EVACUATION | FAIL_TASK`   
Required: No

## Response Syntax
<a name="API_StartCapacityTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssetId": "string",
   "CapacityTaskId": "string",
   "CapacityTaskStatus": "string",
   "CompletionDate": number,
   "CreationDate": number,
   "DryRun": boolean,
   "Failed": { 
      "Reason": "string",
      "Type": "string"
   },
   "InstancesToExclude": { 
      "AccountIds": [ "string" ],
      "Instances": [ "string" ],
      "Services": [ "string" ]
   },
   "LastModifiedDate": number,
   "OrderId": "string",
   "OutpostId": "string",
   "RequestedInstancePools": [ 
      { 
         "Count": number,
         "InstanceType": "string"
      }
   ],
   "TaskActionOnBlockingInstances": "string"
}
```

## Response Elements
<a name="API_StartCapacityTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssetId](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-AssetId"></a>
The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\w+)$` 

 ** [CapacityTaskId](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-CapacityTaskId"></a>
ID of the capacity task that you want to start.  
Type: String  
Length Constraints: Fixed length of 21.  
Pattern: `^cap-[a-f0-9]{17}$` 

 ** [CapacityTaskStatus](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-CapacityTaskStatus"></a>
Status of the specified capacity task.  
Type: String  
Valid Values: `REQUESTED | IN_PROGRESS | FAILED | COMPLETED | WAITING_FOR_EVACUATION | CANCELLATION_IN_PROGRESS | CANCELLED` 

 ** [CompletionDate](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-CompletionDate"></a>
Date that the specified capacity task ran successfully.  
Type: Timestamp

 ** [CreationDate](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-CreationDate"></a>
Date that the specified capacity task was created.  
Type: Timestamp

 ** [DryRun](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-DryRun"></a>
Results of the dry run showing if the specified capacity task is above or below the available instance capacity.  
Type: Boolean

 ** [Failed](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-Failed"></a>
Reason that the specified capacity task failed.  
Type: [CapacityTaskFailure](API_CapacityTaskFailure.md) object

 ** [InstancesToExclude](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-InstancesToExclude"></a>
User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.  
Type: [InstancesToExclude](API_InstancesToExclude.md) object

 ** [LastModifiedDate](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-LastModifiedDate"></a>
Date that the specified capacity task was last modified.  
Type: Timestamp

 ** [OrderId](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-OrderId"></a>
ID of the AWS Outposts order of the host associated with the capacity task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20.  
Pattern: `oo-[a-f0-9]{17}$` 

 ** [OutpostId](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-OutpostId"></a>
ID of the Outpost associated with the capacity task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$` 

 ** [RequestedInstancePools](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-RequestedInstancePools"></a>
List of the instance pools requested in the specified capacity task.  
Type: Array of [InstanceTypeCapacity](API_InstanceTypeCapacity.md) objects

 ** [TaskActionOnBlockingInstances](#API_StartCapacityTask_ResponseSyntax) **   <a name="outposts-StartCapacityTask-response-TaskActionOnBlockingInstances"></a>
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.
Type: String  
Valid Values: `WAIT_FOR_EVACUATION | FAIL_TASK` 

## Errors
<a name="API_StartCapacityTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_StartCapacityTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/StartCapacityTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/StartCapacityTask) 

# StartConnection
<a name="API_StartConnection"></a>

**Note**  
 AWS uses this action to install Outpost servers.

 Starts the connection required for Outpost server installation. 

 Use CloudTrail to monitor this action or AWS managed policy for AWS Outposts to secure it. For more information, see [AWS managed policies for AWS Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) and [ Logging AWS Outposts API calls with AWS CloudTrail](https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) in the * AWS Outposts User Guide*. 

## Request Syntax
<a name="API_StartConnection_RequestSyntax"></a>

```
POST /connections HTTP/1.1
Content-type: application/json

{
   "AssetId": "string",
   "ClientPublicKey": "string",
   "DeviceSerialNumber": "string",
   "NetworkInterfaceDeviceIndex": number
}
```

## URI Request Parameters
<a name="API_StartConnection_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartConnection_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AssetId](#API_StartConnection_RequestSyntax) **   <a name="outposts-StartConnection-request-AssetId"></a>
 The ID of the Outpost server.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\w+)$`   
Required: Yes

 ** [ClientPublicKey](#API_StartConnection_RequestSyntax) **   <a name="outposts-StartConnection-request-ClientPublicKey"></a>
 The public key of the client.   
Type: String  
Length Constraints: Fixed length of 44.  
Pattern: `^[a-zA-Z0-9/+]{43}=$`   
Required: Yes

 ** [DeviceSerialNumber](#API_StartConnection_RequestSyntax) **   <a name="outposts-StartConnection-request-DeviceSerialNumber"></a>
 The serial number of the dongle.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\w+)$`   
Required: No

 ** [NetworkInterfaceDeviceIndex](#API_StartConnection_RequestSyntax) **   <a name="outposts-StartConnection-request-NetworkInterfaceDeviceIndex"></a>
 The device index of the network interface on the Outpost server.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

## Response Syntax
<a name="API_StartConnection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ConnectionId": "string",
   "UnderlayIpAddress": "string"
}
```

## Response Elements
<a name="API_StartConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionId](#API_StartConnection_ResponseSyntax) **   <a name="outposts-StartConnection-response-ConnectionId"></a>
 The ID of the connection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[a-zA-Z0-9+/=]{1,1024}$` 

 ** [UnderlayIpAddress](#API_StartConnection_ResponseSyntax) **   <a name="outposts-StartConnection-response-UnderlayIpAddress"></a>
 The underlay IP address.   
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `^([0-9]{1,3}\.){3}[0-9]{1,3}$` 

## Errors
<a name="API_StartConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_StartConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/StartConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/StartConnection) 

# StartOutpostDecommission
<a name="API_StartOutpostDecommission"></a>

Starts the decommission process to return the Outposts racks or servers.

## Request Syntax
<a name="API_StartOutpostDecommission_RequestSyntax"></a>

```
POST /outposts/OutpostId/decommission HTTP/1.1
Content-type: application/json

{
   "ValidateOnly": boolean
}
```

## URI Request Parameters
<a name="API_StartOutpostDecommission_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OutpostId](#API_StartOutpostDecommission_RequestSyntax) **   <a name="outposts-StartOutpostDecommission-request-uri-OutpostIdentifier"></a>
The ID or ARN of the Outpost that you want to decommission.  
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_StartOutpostDecommission_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ValidateOnly](#API_StartOutpostDecommission_RequestSyntax) **   <a name="outposts-StartOutpostDecommission-request-ValidateOnly"></a>
Validates the request without starting the decommission process.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_StartOutpostDecommission_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BlockingResourceTypes": [ "string" ],
   "Status": "string"
}
```

## Response Elements
<a name="API_StartOutpostDecommission_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BlockingResourceTypes](#API_StartOutpostDecommission_ResponseSyntax) **   <a name="outposts-StartOutpostDecommission-response-BlockingResourceTypes"></a>
The resources still associated with the Outpost that you are decommissioning.  
Type: Array of strings  
Valid Values: `EC2_INSTANCE | OUTPOST_RAM_SHARE | LGW_ROUTING_DOMAIN | LGW_ROUTE_TABLE | LGW_VIRTUAL_INTERFACE_GROUP | OUTPOST_ORDER_CANCELLABLE | OUTPOST_ORDER_INTERVENTION_REQUIRED` 

 ** [Status](#API_StartOutpostDecommission_ResponseSyntax) **   <a name="outposts-StartOutpostDecommission-response-Status"></a>
The status of the decommission request.  
Type: String  
Valid Values: `SKIPPED | BLOCKED | REQUESTED` 

## Errors
<a name="API_StartOutpostDecommission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_StartOutpostDecommission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/StartOutpostDecommission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/StartOutpostDecommission) 

# TagResource
<a name="API_TagResource"></a>

Adds tags to the specified resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="outposts-TagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Length Constraints: Maximum length of 1011.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="outposts-TagResource-request-Tags"></a>
The tags to add to the resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[\S \n]+$`   
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from the specified resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="outposts-UntagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Length Constraints: Maximum length of 1011.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:([a-z\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="outposts-UntagResource-request-uri-TagKeys"></a>
The tag keys.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UntagResource) 

# UpdateOutpost
<a name="API_UpdateOutpost"></a>

 Updates an Outpost. 

## Request Syntax
<a name="API_UpdateOutpost_RequestSyntax"></a>

```
PATCH /outposts/OutpostId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "SupportedHardwareType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateOutpost_RequestParameters"></a>

The request uses the following URI parameters.

 ** [OutpostId](#API_UpdateOutpost_RequestSyntax) **   <a name="outposts-UpdateOutpost-request-uri-OutpostId"></a>
 The ID or ARN of the Outpost.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `OutpostId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 180.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$`   
Required: Yes

## Request Body
<a name="API_UpdateOutpost_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateOutpost_RequestSyntax) **   <a name="outposts-UpdateOutpost-request-Description"></a>
The description of the Outpost.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `^[\S ]*$`   
Required: No

 ** [Name](#API_UpdateOutpost_RequestSyntax) **   <a name="outposts-UpdateOutpost-request-Name"></a>
The name of the Outpost.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\S ]+$`   
Required: No

 ** [SupportedHardwareType](#API_UpdateOutpost_RequestSyntax) **   <a name="outposts-UpdateOutpost-request-SupportedHardwareType"></a>
 The type of hardware for this Outpost.   
Type: String  
Valid Values: `RACK | SERVER`   
Required: No

## Response Syntax
<a name="API_UpdateOutpost_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Outpost": { 
      "AvailabilityZone": "string",
      "AvailabilityZoneId": "string",
      "Description": "string",
      "LifeCycleStatus": "string",
      "Name": "string",
      "OutpostArn": "string",
      "OutpostId": "string",
      "OwnerId": "string",
      "SiteArn": "string",
      "SiteId": "string",
      "SupportedHardwareType": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_UpdateOutpost_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Outpost](#API_UpdateOutpost_ResponseSyntax) **   <a name="outposts-UpdateOutpost-response-Outpost"></a>
Information about an Outpost.  
Type: [Outpost](API_Outpost.md) object

## Errors
<a name="API_UpdateOutpost_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateOutpost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UpdateOutpost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UpdateOutpost) 

# UpdateSite
<a name="API_UpdateSite"></a>

Updates the specified site.

## Request Syntax
<a name="API_UpdateSite_RequestSyntax"></a>

```
PATCH /sites/SiteId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Notes": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSite_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SiteId](#API_UpdateSite_RequestSyntax) **   <a name="outposts-UpdateSite-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_UpdateSite_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateSite_RequestSyntax) **   <a name="outposts-UpdateSite-request-Description"></a>
The description of the site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1001.  
Pattern: `^[\S ]+$`   
Required: No

 ** [Name](#API_UpdateSite_RequestSyntax) **   <a name="outposts-UpdateSite-request-Name"></a>
The name of the site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^[\S ]+$`   
Required: No

 ** [Notes](#API_UpdateSite_RequestSyntax) **   <a name="outposts-UpdateSite-request-Notes"></a>
Notes about a site.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `^[\S \n]+$`   
Required: No

## Response Syntax
<a name="API_UpdateSite_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "AccountId": "string",
      "Description": "string",
      "Name": "string",
      "Notes": "string",
      "OperatingAddressCity": "string",
      "OperatingAddressCountryCode": "string",
      "OperatingAddressStateOrRegion": "string",
      "RackPhysicalProperties": { 
         "FiberOpticCableType": "string",
         "MaximumSupportedWeightLbs": "string",
         "OpticalStandard": "string",
         "PowerConnector": "string",
         "PowerDrawKva": "string",
         "PowerFeedDrop": "string",
         "PowerPhase": "string",
         "UplinkCount": "string",
         "UplinkGbps": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_UpdateSite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Site](#API_UpdateSite_ResponseSyntax) **   <a name="outposts-UpdateSite-response-Site"></a>
Information about a site.  
Type: [Site](API_Site.md) object

## Errors
<a name="API_UpdateSite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UpdateSite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UpdateSite) 

# UpdateSiteAddress
<a name="API_UpdateSiteAddress"></a>

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.

## Request Syntax
<a name="API_UpdateSiteAddress_RequestSyntax"></a>

```
PUT /sites/SiteId/address HTTP/1.1
Content-type: application/json

{
   "Address": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "AddressType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSiteAddress_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SiteId](#API_UpdateSiteAddress_RequestSyntax) **   <a name="outposts-UpdateSiteAddress-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_UpdateSiteAddress_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Address](#API_UpdateSiteAddress_RequestSyntax) **   <a name="outposts-UpdateSiteAddress-request-Address"></a>
 The address for the site.   
Type: [Address](API_Address.md) object  
Required: Yes

 ** [AddressType](#API_UpdateSiteAddress_RequestSyntax) **   <a name="outposts-UpdateSiteAddress-request-AddressType"></a>
 The type of the address.   
Type: String  
Valid Values: `SHIPPING_ADDRESS | OPERATING_ADDRESS`   
Required: Yes

## Response Syntax
<a name="API_UpdateSiteAddress_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Address": { 
      "AddressLine1": "string",
      "AddressLine2": "string",
      "AddressLine3": "string",
      "City": "string",
      "ContactName": "string",
      "ContactPhoneNumber": "string",
      "CountryCode": "string",
      "DistrictOrCounty": "string",
      "Municipality": "string",
      "PostalCode": "string",
      "StateOrRegion": "string"
   },
   "AddressType": "string"
}
```

## Response Elements
<a name="API_UpdateSiteAddress_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Address](#API_UpdateSiteAddress_ResponseSyntax) **   <a name="outposts-UpdateSiteAddress-response-Address"></a>
 Information about an address.   
Type: [Address](API_Address.md) object

 ** [AddressType](#API_UpdateSiteAddress_ResponseSyntax) **   <a name="outposts-UpdateSiteAddress-response-AddressType"></a>
 The type of the address.   
Type: String  
Valid Values: `SHIPPING_ADDRESS | OPERATING_ADDRESS` 

## Errors
<a name="API_UpdateSiteAddress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSiteAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UpdateSiteAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UpdateSiteAddress) 

# UpdateSiteRackPhysicalProperties
<a name="API_UpdateSiteRackPhysicalProperties"></a>

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see [Network readiness checklist](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) in the AWS 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.

## Request Syntax
<a name="API_UpdateSiteRackPhysicalProperties_RequestSyntax"></a>

```
PATCH /sites/SiteId/rackPhysicalProperties HTTP/1.1
Content-type: application/json

{
   "FiberOpticCableType": "string",
   "MaximumSupportedWeightLbs": "string",
   "OpticalStandard": "string",
   "PowerConnector": "string",
   "PowerDrawKva": "string",
   "PowerFeedDrop": "string",
   "PowerPhase": "string",
   "UplinkCount": "string",
   "UplinkGbps": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSiteRackPhysicalProperties_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SiteId](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-uri-SiteId"></a>
 The ID or the Amazon Resource Name (ARN) of the site.   
Despite the parameter name, you can make the request with an ARN. The parameter name is `SiteId` for backward compatibility.
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$`   
Required: Yes

## Request Body
<a name="API_UpdateSiteRackPhysicalProperties_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FiberOpticCableType](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-FiberOpticCableType"></a>
The type of fiber that you will use to attach the Outpost to your network.   
Type: String  
Valid Values: `SINGLE_MODE | MULTI_MODE`   
Required: No

 ** [MaximumSupportedWeightLbs](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-MaximumSupportedWeightLbs"></a>
The maximum rack weight that this site can support. `NO_LIMIT` is over 2000lbs.   
Type: String  
Valid Values: `NO_LIMIT | MAX_1400_LBS | MAX_1600_LBS | MAX_1800_LBS | MAX_2000_LBS`   
Required: No

 ** [OpticalStandard](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-OpticalStandard"></a>
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](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) in the AWS 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
Type: String  
Valid Values: `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`   
Required: No

 ** [PowerConnector](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-PowerConnector"></a>
The power connector that AWS 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\$1N\$1E, 6hr; 32 A; single phase
+ Three-phase AC feed
  +  **AH530P7W (red)** – 3P\$1N\$1E, 7hr; 30A; three phase
  +  **AH532P6W (red)** – 3P\$1N\$1E, 6hr; 32A; three phase
  +  **CS8365C** – (common in US); 3P\$1E, 50A; three phase
Type: String  
Valid Values: `L6_30P | IEC309 | AH530P7W | AH532P6W | CS8365C`   
Required: No

 ** [PowerDrawKva](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-PowerDrawKva"></a>
The power draw, in kVA, available at the hardware placement position for the rack.  
Type: String  
Valid Values: `POWER_5_KVA | POWER_10_KVA | POWER_15_KVA | POWER_30_KVA`   
Required: No

 ** [PowerFeedDrop](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-PowerFeedDrop"></a>
Indicates whether the power feed comes above or below the rack.   
Type: String  
Valid Values: `ABOVE_RACK | BELOW_RACK`   
Required: No

 ** [PowerPhase](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-PowerPhase"></a>
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
Type: String  
Valid Values: `SINGLE_PHASE | THREE_PHASE`   
Required: No

 ** [UplinkCount](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-UplinkCount"></a>
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
Type: String  
Valid Values: `UPLINK_COUNT_1 | UPLINK_COUNT_2 | UPLINK_COUNT_3 | UPLINK_COUNT_4 | UPLINK_COUNT_5 | UPLINK_COUNT_6 | UPLINK_COUNT_7 | UPLINK_COUNT_8 | UPLINK_COUNT_12 | UPLINK_COUNT_16`   
Required: No

 ** [UplinkGbps](#API_UpdateSiteRackPhysicalProperties_RequestSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-request-UplinkGbps"></a>
The uplink speed the rack should support for the connection to the Region.   
Type: String  
Valid Values: `UPLINK_1G | UPLINK_10G | UPLINK_40G | UPLINK_100G`   
Required: No

## Response Syntax
<a name="API_UpdateSiteRackPhysicalProperties_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Site": { 
      "AccountId": "string",
      "Description": "string",
      "Name": "string",
      "Notes": "string",
      "OperatingAddressCity": "string",
      "OperatingAddressCountryCode": "string",
      "OperatingAddressStateOrRegion": "string",
      "RackPhysicalProperties": { 
         "FiberOpticCableType": "string",
         "MaximumSupportedWeightLbs": "string",
         "OpticalStandard": "string",
         "PowerConnector": "string",
         "PowerDrawKva": "string",
         "PowerFeedDrop": "string",
         "PowerPhase": "string",
         "UplinkCount": "string",
         "UplinkGbps": "string"
      },
      "SiteArn": "string",
      "SiteId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_UpdateSiteRackPhysicalProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Site](#API_UpdateSiteRackPhysicalProperties_ResponseSyntax) **   <a name="outposts-UpdateSiteRackPhysicalProperties-response-Site"></a>
Information about a site.  
Type: [Site](API_Site.md) object

## Errors
<a name="API_UpdateSiteRackPhysicalProperties_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have permission to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
Updating or deleting this resource can cause an inconsistent state.    
 ** ResourceId **   
The ID of the resource causing the conflict.  
 ** ResourceType **   
The type of the resource causing the conflict.
HTTP Status Code: 409

 ** InternalServerException **   
An internal error has occurred.  
HTTP Status Code: 500

 ** NotFoundException **   
The specified request is not valid.  
HTTP Status Code: 404

 ** ValidationException **   
A parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSiteRackPhysicalProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/outposts-2019-12-03/UpdateSiteRackPhysicalProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/outposts-2019-12-03/UpdateSiteRackPhysicalProperties)