[ aws . freetier ]

get-free-tier-usage

Description

Returns a list of all Free Tier usage objects that match your filters.

See also: AWS API Documentation

get-free-tier-usage 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: freeTierUsages

Synopsis

  get-free-tier-usage
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--filter (structure)

An expression that specifies the conditions that you want each FreeTierUsage object to meet.

And -> (list)

Return results that match all Expressions that you specified in the array.

(structure)

Use Expression to filter in the GetFreeTierUsage API operation.

You can use the following patterns:

• Simple dimension values (Dimensions root operator)
• Complex expressions with logical operators (AND , NOT , and OR root operators).

For simple dimension values , you can set the dimension name, values, and match type for the filters that you plan to use.

Example for simple dimension values

You can filter to match exactly for REGION==us-east-1 OR REGION==us-west-1 .

The corresponding Expression appears like the following: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }

As shown in the previous example, lists of dimension values are combined with OR when you apply the filter.

For complex expressions with logical operators , you can have nested expressions to use the logical operators and specify advanced filtering.

Example for complex expressions with logical operators

You can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer) .

The corresponding Expression appears like the following: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] }

In the following Contents , you must specify exactly one of the following root operators.

And -> (list)

Return results that match all Expressions that you specified in the array.

( … recursive … )

Dimensions -> (structure)

The specific dimension, values, and match type to filter objects with.

Key -> (string)

The name of the dimension that you want to filter on.

MatchOptions -> (list)

The match options that you can use to filter your results. You can specify only one of these values in the array.

(string)

Values -> (list)

The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

(string)

( … recursive … )Or -> (list)

Return results that match any of the Expressions that you specified. in the array.

( … recursive … )

Dimensions -> (structure)

The specific dimension, values, and match type to filter objects with.

Key -> (string)

The name of the dimension that you want to filter on.

MatchOptions -> (list)

The match options that you can use to filter your results. You can specify only one of these values in the array.

(string)

Values -> (list)

The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

(string)

Not -> (structure)

Return results that don’t match the Expression that you specified.

And -> (list)

Return results that match all Expressions that you specified in the array.

( … recursive … )

Dimensions -> (structure)

The specific dimension, values, and match type to filter objects with.

Key -> (string)

The name of the dimension that you want to filter on.

MatchOptions -> (list)

The match options that you can use to filter your results. You can specify only one of these values in the array.

(string)

Values -> (list)

The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

(string)

( … recursive … )Or -> (list)

Return results that match any of the Expressions that you specified. in the array.

( … recursive … )

Or -> (list)

Return results that match any of the Expressions that you specified. in the array.

(structure)

Use Expression to filter in the GetFreeTierUsage API operation.

You can use the following patterns:

• Simple dimension values (Dimensions root operator)
• Complex expressions with logical operators (AND , NOT , and OR root operators).

For simple dimension values , you can set the dimension name, values, and match type for the filters that you plan to use.

Example for simple dimension values

You can filter to match exactly for REGION==us-east-1 OR REGION==us-west-1 .

The corresponding Expression appears like the following: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }

As shown in the previous example, lists of dimension values are combined with OR when you apply the filter.

For complex expressions with logical operators , you can have nested expressions to use the logical operators and specify advanced filtering.

Example for complex expressions with logical operators

You can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer) .

The corresponding Expression appears like the following: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] }

In the following Contents , you must specify exactly one of the following root operators.

And -> (list)

Return results that match all Expressions that you specified in the array.

( … recursive … )

Dimensions -> (structure)

The specific dimension, values, and match type to filter objects with.

Key -> (string)

The name of the dimension that you want to filter on.

MatchOptions -> (list)

The match options that you can use to filter your results. You can specify only one of these values in the array.

(string)

Values -> (list)

The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

(string)

( … recursive … )Or -> (list)

Return results that match any of the Expressions that you specified. in the array.

( … recursive … )

JSON Syntax:

{
  "And": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Dimensions": {
        "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
        "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
        "Values": ["string", ...]
      },
      "Not": { ... recursive ... },
      "Or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ],
  "Dimensions": {
    "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
    "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
    "Values": ["string", ...]
  },
  "Not": {
    "And": [
      { ... recursive ... }
      ...
    ],
    "Dimensions": {
      "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
      "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
      "Values": ["string", ...]
    },
    "Not": { ... recursive ... },
    "Or": [
      { ... recursive ... }
      ...
    ]
  },
  "Or": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Dimensions": {
        "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
        "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
        "Values": ["string", ...]
      },
      "Not": { ... recursive ... },
      "Or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ]
}

--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.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

freeTierUsages -> (list)

The list of Free Tier usage objects that meet your filter expression.

(structure)

Consists of a Amazon Web Services Free Tier offer’s metadata and your data usage for the offer.

actualUsageAmount -> (double)

Describes the actual usage accrued month-to-day (MTD) that you’ve used so far.

description -> (string)

The description of the Free Tier offer.

forecastedUsageAmount -> (double)

Describes the forecasted usage by the month that you’re expected to use.

freeTierType -> (string)

Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free" , "Always Free" , and "Free Trial" .

limit -> (double)

Describes the maximum usage allowed in Free Tier.

operation -> (string)

Describes usageType more granularly with the specific Amazon Web Service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud.

region -> (string)

Describes the Amazon Web Services Region for which this offer is applicable

service -> (string)

The name of the Amazon Web Service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.

unit -> (string)

Describes the unit of the usageType , such as Hrs .

usageType -> (string)

Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial .

nextToken -> (string)

The pagination token that indicates the next set of results to retrieve.