[ aws . billingconductor ]

list-pricing-rules

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-pricing-rules is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PricingRules

Synopsis

  list-pricing-rules
[--billing-period <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--billing-period (string)

The preferred billing period to get the pricing plan.

--filters (structure)

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

Arns -> (list)

A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.

(string)

Shorthand Syntax:

Arns=string,string

JSON Syntax:

{
  "Arns": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

BillingPeriod -> (string)

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

PricingRules -> (list)

A list containing the described pricing rules.

(structure)

A representation of a pricing rule.

Name -> (string)

The name of a pricing rule.

Arn -> (string)

The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

Description -> (string)

The pricing rule description.

Scope -> (string)

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

Type -> (string)

The type of pricing rule.

ModifierPercentage -> (double)

A percentage modifier applied on the public pricing rates.

Service -> (string)

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

AssociatedPricingPlanCount -> (long)

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

CreationTime -> (long)

The time the pricing rule was created.

LastModifiedTime -> (long)

The most recent time the pricing rule was modified.

NextToken -> (string)

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