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

UpdatePricingRule

Updates an existing pricing rule.

Request Syntax


PUT /update-pricing-rule HTTP/1.1
Content-type: application/json

{
   "Arn": "string",
   "Description": "string",
   "ModifierPercentage": number,
   "Name": "string",
   "Tiering": { 
      "FreeTier": { 
         "Activated": boolean
      }
   },
   "Type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Arn

The Amazon Resource Name (ARN) of the pricing rule to update.

Type: String

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

Required: Yes

Description

The new description for the pricing rule.

Type: String

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

Required: No

ModifierPercentage

The new modifier to show pricing plan rates as a percentage. Your entry will be rounded to the nearest 2 decimal places.

Type: Double

Valid Range: Minimum value of 0.

Required: No

Name

The new name of the pricing rule. The name must be unique to each pricing rule.

Type: String

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

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

Required: No

Tiering

The set of tiering configurations for the pricing rule.

Type: UpdateTieringInput object

Required: No

Type

The new pricing rule type.

Type: String

Valid Values: MARKUP | DISCOUNT | TIERING

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "AssociatedPricingPlanCount": number,
   "BillingEntity": "string",
   "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.

Arn

The Amazon Resource Name (ARN) of the successfully updated pricing rule.

Type: String

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

AssociatedPricingPlanCount

The pricing plans count that this pricing rule is associated with.

Type: Long

Valid Range: Minimum value of 0.

BillingEntity

The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplace.

Type: String

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

Description

The new description for the pricing rule.

Type: String

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

LastModifiedTime

The most recent time the pricing rule was modified.

Type: Long

ModifierPercentage

The new modifier to show pricing plan rates as a percentage.

Type: Double

Valid Range: Minimum value of 0.

Name

The new name of the pricing rule. The name must be unique to each pricing rule.

Type: String

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

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

Operation

Operation refers to the specific AWS covered by this line item. This describes the specific usage of the line item.

If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

Type: String

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

Pattern: \S+

Scope

The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

Type: String

Valid Values: GLOBAL | SERVICE | BILLING_ENTITY | SKU

Service

If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

Type: String

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

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

Tiering

The set of tiering configurations for the pricing rule.

Type: UpdateTieringInput object

Type

The new pricing rule type.

Type: String

Valid Values: MARKUP | DISCOUNT | TIERING

UsageType

Usage type is the unit that each service uses to measure the usage of a specific type of resource.

If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

Type: String

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

Pattern: \S+

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.

Reason: Reason for the inconsistent state.
ResourceId: Identifier of the resource in use.
ResourceType: Type of the resource in use.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

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

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

ResourceId: Resource identifier that was not found.
ResourceType: Resource type that was not found.

HTTP Status Code: 404

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