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

CreatePricingPlan

Creates a pricing plan that is used for computing AWS charges for billing groups.

Request Syntax


POST /create-pricing-plan HTTP/1.1
X-Amzn-Client-Token: ClientToken
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "PricingRuleArns": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

ClientToken

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

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

Pattern: [a-zA-Z0-9-]+

Request Body

The request accepts the following data in JSON format.

Description

The description of the pricing plan.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

Name

The name of the pricing plan. The names must be unique to each pricing plan.

Type: String

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

Pattern: [a-zA-Z0-9_\+=\.\-@]+

Required: Yes

PricingRuleArns

A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 30 items.

Pattern: (arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}

Required: No

Tags

A map that contains tag keys and tag values that are attached to a pricing plan.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "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.

Arn

The Amazon Resource Name (ARN) of the created pricing plan.

Type: String

Pattern: (arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}

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

ConflictException

You can cause an inconsistent state by updating or deleting a resource.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ServiceLimitExceededException

The request would cause a service limit to exceed.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400