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

GetRenewalPricing

Gets all available renewal pricing options for the specified Outpost.

Request Syntax


GET /outpost/OutpostIdentifier/renewal-pricing HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

OutpostIdentifier

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

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PricingOptions": [ 
      { 
         "PricingType": "string",
         "SubscriptionPricingDetails": { 
            "Currency": "string",
            "MonthlyRecurringPrice": number,
            "PaymentOption": "string",
            "PaymentTerm": "string",
            "UpfrontPrice": number
         }
      }
   ],
   "PricingResult": "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.

PricingOptions

The pricing options for the specified Outpost.

Type: Array of PricingOption objects

Array Members: Maximum number of 9 items.

PricingResult

The result of the pricing request.

Type: String

Valid Values: PRICED | UNABLE_TO_PRICE

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 displays the available renewal pricing options for the specified Outpost.

Sample Request


aws outposts get-renewal-pricing --outpost-identifier op-1234567890example

Sample Response


{
  "PricingResult": "PRICED",
  "PricingOptions": [
    {
      "PricingType": "SUBSCRIPTION",
      "SubscriptionPricingDetails": {
        "PaymentOption": "ALL_UPFRONT",
        "PaymentTerm": "ONE_YEAR",
        "UpfrontPrice": 12000.00,
        "MonthlyRecurringPrice": 0.0,
        "Currency": "USD"
      }
    },
    {
      "PricingType": "SUBSCRIPTION",
      "SubscriptionPricingDetails": {
        "PaymentOption": "NO_UPFRONT",
        "PaymentTerm": "ONE_YEAR",
        "UpfrontPrice": 0.0,
        "MonthlyRecurringPrice": 1100.00,
        "Currency": "USD"
      }
    }
  ]
}