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

ListPricingRules

Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.

Request Syntax


POST /list-pricing-rules HTTP/1.1
Content-type: application/json

{
   "BillingPeriod": "string",
   "Filters": { 
      "Arns": [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

BillingPeriod

The preferred billing period to get the pricing plan.

Type: String

Pattern: \d{4}-(0?[1-9]|1[012])

Required: No

Filters

A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

Type: ListPricingRulesFilter object

Required: No

MaxResults

The maximum number of pricing rules to retrieve.

Type: Integer

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

Required: No

NextToken

The pagination token that's used on subsequent call to get pricing rules.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BillingPeriod": "string",
   "NextToken": "string",
   "PricingRules": [ 
      { 
         "Arn": "string",
         "AssociatedPricingPlanCount": number,
         "BillingEntity": "string",
         "CreationTime": number,
         "Description": "string",
         "LastModifiedTime": number,
         "ModifierPercentage": number,
         "Name": "string",
         "Operation": "string",
         "Scope": "string",
         "Service": "string",
         "Tiering": { 
            "FreeTier": { 
               "Activated": boolean
            }
         },
         "Type": "string",
         "UsageType": "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.

BillingPeriod

The billing period for which the described pricing rules are applicable.

Type: String

Pattern: \d{4}-(0?[1-9]|1[012])

NextToken

The pagination token that's used on subsequent calls to get pricing rules.

Type: String

PricingRules

A list containing the described pricing rules.

Type: Array of PricingRuleListElement objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

RetryAfterSeconds: Number of seconds you can retry after the call.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds: Number of seconds you can safely retry after the call.

HTTP Status Code: 429

ValidationException

The input doesn't match with the constraints specified by AWS services.

Fields: The fields that caused the error, if applicable.
Reason: The reason the request's validation failed.

HTTP Status Code: 400