Updates an Outpost.
Request Syntax
PATCH /outposts/OutpostId HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Name": "string",
"SupportedHardwareType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- OutpostId
-
The ID or ARN of the Outpost.
Note
Despite the parameter name, you can make the request with an ARN. The parameter name is
OutpostIdfor 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
The request accepts the following data in JSON format.
- Description
-
The description of the Outpost.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^[\S ]*$Required: No
- Name
-
The name of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[\S ]+$Required: No
- SupportedHardwareType
-
The type of hardware for this Outpost.
Type: String
Valid Values:
RACK | SERVERRequired: No
Response Syntax
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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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.
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
