AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . billingconductor ]

update-pricing-rule

Description

Updates an existing pricing rule.

See also: AWS API Documentation

Synopsis

  update-pricing-rule
--arn <value>
[--name <value>]
[--description <value>]
[--type <value>]
[--modifier-percentage <value>]
[--tiering <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--arn (string)

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

--name (string)

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

--description (string)

The new description for the pricing rule.

--type (string)

The new pricing rule type.

Possible values:

  • MARKUP
  • DISCOUNT
  • TIERING

--modifier-percentage (double)

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

--tiering (structure)

The set of tiering configurations for the pricing rule.

FreeTier -> (structure)

The possible Amazon Web Services Free Tier configurations.

Activated -> (boolean)

Activate or deactivate application of Amazon Web Services Free Tier.

Shorthand Syntax:

FreeTier={Activated=boolean}

JSON Syntax:

{
  "FreeTier": {
    "Activated": true|false
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Arn -> (string)

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

Name -> (string)

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

Description -> (string)

The new description for the pricing rule.

Scope -> (string)

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

Type -> (string)

The new pricing rule type.

ModifierPercentage -> (double)

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

Service -> (string)

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

AssociatedPricingPlanCount -> (long)

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

LastModifiedTime -> (long)

The most recent time the pricing rule was modified.

BillingEntity -> (string)

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

Tiering -> (structure)

The set of tiering configurations for the pricing rule.

FreeTier -> (structure)

The possible Amazon Web Services Free Tier configurations.

Activated -> (boolean)

Activate or deactivate application of Amazon Web Services Free Tier.

UsageType -> (string)

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.

Operation -> (string)

Operation refers to the specific Amazon Web Services 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.