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

GetOutpostBillingInformation

Gets current and historical billing information about the specified Outpost.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum page size.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The pagination token.

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

Pattern: ^(\d+)##(\S+)$

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

{
   "ContractEndDate": "string",
   "NextToken": "string",
   "Subscriptions": [ 
      { 
         "BeginDate": number,
         "EndDate": number,
         "MonthlyRecurringPrice": number,
         "OrderIds": [ "string" ],
         "SubscriptionId": "string",
         "SubscriptionStatus": "string",
         "SubscriptionType": "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.

ContractEndDate

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

The pagination token.

Type: String

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

Pattern: ^(\d+)##(\S+)$

Subscriptions

The subscription details for the specified Outpost.

Type: Array of Subscription objects

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

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

Examples

Example

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

Sample Request


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

Sample Response


{
  "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"
}