Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateRenewal

Creates a renewal contract for the specified Outpost.

Request Syntax


POST /renewals HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "OutpostIdentifier": "string",
   "PaymentOption": "string",
   "PaymentTerm": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^.*$

Required: No

OutpostIdentifier

The ID or 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

The payment option.

Type: String

Valid Values: ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT

Required: Yes

PaymentTerm

The payment term.

Type: String

Valid Values: THREE_YEARS | ONE_YEAR | FIVE_YEARS

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Currency": "string",
   "MonthlyRecurringPrice": number,
   "OutpostId": "string",
   "PaymentOption": "string",
   "PaymentTerm": "string",
   "UpfrontPrice": number
}

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.

Currency

The currency of the renewal price.

Type: String

Valid Values: USD

MonthlyRecurringPrice

The monthly recurring price of the renewal.

Type: Float

OutpostId

The ID of the Outpost.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^op-[a-f0-9]{17}$

PaymentOption

The payment option.

Type: String

Valid Values: ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT

PaymentTerm

The payment term.

Type: String

Valid Values: THREE_YEARS | ONE_YEAR | FIVE_YEARS

UpfrontPrice

The upfront price of the renewal.

Type: Float

Errors

For information about the errors that are common to all actions, see Common Error Types.

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

Examples

Example

This example creates a renewal for the specified Outpost.

Sample Request


aws outposts create-renewal --outpost-identifier op-1234567890example --payment-option ALL_UPFRONT --payment-term ONE_YEAR

Sample Response


{
  "PaymentOption": "ALL_UPFRONT",
  "PaymentTerm": "ONE_YEAR",
  "OutpostId": "op-1234567890example",
  "UpfrontPrice": 12000.00,
  "MonthlyRecurringPrice": 0.0,
  "Currency": "USD"
}