Creates a new Cost Category with the requested name and rules.
See also: AWS API Documentation
create-cost-category-definition
--name <value>
[--effective-start <value>]
--rule-version <value>
--rules <value>
[--default-value <value>]
[--split-charge-rules <value>]
[--resource-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
--name
(string)
The unique name of the Cost Category.
--effective-start
(string)
The Cost Category’s effective start date. It can only be a billing start date (first day of the month). If the date isn’t provided, it’s the first day of the current month. Dates can’t be before the previous twelve months, or in the future.
--rule-version
(string)
The rule schema version in this particular Cost Category.
Possible values:
CostCategoryExpression.v1
--rules
(list)
The Cost Category rules used to categorize costs. For more information, see CostCategoryRule .
(structure)
Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
Value -> (string)
The default value for the cost category.
Rule -> (structure)
An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are
LINKED_ACCOUNT
,SERVICE_CODE
,RECORD_TYPE
, andLINKED_ACCOUNT_NAME
.Root level
OR
isn’t supported. We recommend that you create a separate rule instead.
RECORD_TYPE
is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you’re using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide .Or -> (list)
Return results that match either
Dimension
object.(structure)
Use
Expression
to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for
REGION==us-east-1 OR REGION==us-west-1
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
. TheExpression
example is as follows:{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }
The list of dimension values are OR’d together to retrieve cost or usage data. You can createExpression
andDimensionValues
objects using eitherwith*
methods orset*
methods in multiple lines.Compound dimension values with logical operations - You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter on more advanced options. For example, you can filter on((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
. TheExpression
for that is as follows:{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each
Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error.
{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
Note
For the
GetRightsizingRecommendation
action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited toLINKED_ACCOUNT
.Or -> (list)
Return results that match either
Dimension
object.( … recursive … )
And -> (list)
Return results that match both
Dimension
objects.( … recursive … )
( … recursive … )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
The names of the metadata types that you can use to filter and group your results. For example,
AZ
returns a list of Availability Zones.LINK_ACCOUNT_NAME
andSERVICE_CODE
can only be used in CostCategoryRule .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.
Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that’s based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.
Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for
MatchOptions
isEQUALS
andCASE_SENSITIVE
.(string)
And -> (list)
Return results that match both
Dimension
objects.(structure)
Use
Expression
to filter by cost or by usage. There are two patterns:
Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for
REGION==us-east-1 OR REGION==us-west-1
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
. TheExpression
example is as follows:{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }
The list of dimension values are OR’d together to retrieve cost or usage data. You can createExpression
andDimensionValues
objects using eitherwith*
methods orset*
methods in multiple lines.Compound dimension values with logical operations - You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter on more advanced options. For example, you can filter on((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
. TheExpression
for that is as follows:{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }
Note
Because each
Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error.
{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
Note
For the
GetRightsizingRecommendation
action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited toLINKED_ACCOUNT
,REGION
, orRIGHTSIZING_TYPE
.For the
GetReservationPurchaseRecommendation
action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited toLINKED_ACCOUNT
.Or -> (list)
Return results that match either
Dimension
object.( … recursive … )
And -> (list)
Return results that match both
Dimension
objects.( … recursive … )
( … recursive … )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
The names of the metadata types that you can use to filter and group your results. For example,
AZ
returns a list of Availability Zones.LINK_ACCOUNT_NAME
andSERVICE_CODE
can only be used in CostCategoryRule .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.
Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that’s based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.
Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for
MatchOptions
isEQUALS
andCASE_SENSITIVE
.(string)
Not -> (structure)
Return results that don’t match a
Dimension
object.Or -> (list)
Return results that match either
Dimension
object.( … recursive … )
And -> (list)
Return results that match both
Dimension
objects.( … recursive … )
( … recursive … )Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
The names of the metadata types that you can use to filter and group your results. For example,
AZ
returns a list of Availability Zones.LINK_ACCOUNT_NAME
andSERVICE_CODE
can only be used in CostCategoryRule .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.
Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that’s based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.
Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for
MatchOptions
isEQUALS
andCASE_SENSITIVE
.(string)
Dimensions -> (structure)
The specific
Dimension
to use forExpression
.Key -> (string)
The names of the metadata types that you can use to filter and group your results. For example,
AZ
returns a list of Availability Zones.LINK_ACCOUNT_NAME
andSERVICE_CODE
can only be used in CostCategoryRule .Values -> (list)
The metadata values that you can use to filter and group your results. You can use
GetDimensionValues
to find specific values.(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
Tags -> (structure)
The specific
Tag
to use forExpression
.Key -> (string)
The key for the tag.
Values -> (list)
The specific value of the tag.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results.
MatchOptions
is only applicable for actions related to Cost Category. The default values forMatchOptions
areEQUALS
andCASE_SENSITIVE
.(string)
CostCategories -> (structure)
The filter that’s based on
CostCategory
values.Key -> (string)
The unique name of the Cost Category.
Values -> (list)
The specific value of the Cost Category.
(string)
MatchOptions -> (list)
The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for
MatchOptions
isEQUALS
andCASE_SENSITIVE
.(string)
InheritedValue -> (structure)
The value the line item is categorized as if the line item contains the matched dimension.
DimensionName -> (string)
The name of the dimension that’s used to group costs.
If you specify
LINKED_ACCOUNT_NAME
, the cost category value is based on account name. If you specifyTAG
, the cost category value is based on the value of the specified tag key.DimensionKey -> (string)
The key to extract cost category values.
Type -> (string)
You can define the
CostCategoryRule
rule type as eitherREGULAR
orINHERITED_VALUE
. TheINHERITED_VALUE
rule type adds the flexibility to define a rule that dynamically inherits the cost category value. This value is from the dimension value that’s defined byCostCategoryInheritedValueDimension
. For example, suppose that you want to costs to be dynamically grouped based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the tag dimension and specify the tag key to use.
JSON Syntax:
[
{
"Value": "string",
"Rule": {
"Or": [
{
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
}
}
...
],
"And": [
{
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
}
}
...
],
"Not": {
"Or": [
{ ... recursive ... }
...
],
"And": [
{ ... recursive ... }
...
],
"Not": { ... recursive ... },
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
}
},
"Dimensions": {
"Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"Tags": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
},
"CostCategories": {
"Key": "string",
"Values": ["string", ...],
"MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
}
},
"InheritedValue": {
"DimensionName": "LINKED_ACCOUNT_NAME"|"TAG",
"DimensionKey": "string"
},
"Type": "REGULAR"|"INHERITED_VALUE"
}
...
]
--default-value
(string)
The default value for the cost category.
--split-charge-rules
(list)
The split charge rules used to allocate your charges between your Cost Category values.
(structure)
Use the split charge rule to split the cost of one Cost Category value across several other target values.
Source -> (string)
The Cost Category value that you want to split. That value can’t be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
Targets -> (list)
The Cost Category values that you want to split costs across. These values can’t be used as a source in other split charge rules.
(string)
Method -> (string)
The method that’s used to define how to split your source costs across your targets.
Proportional
- Allocates charges across your targets based on the proportional weighted cost of each target.
Fixed
- Allocates charges across your targets based on your defined allocation percentage.>``Even`` - Allocates costs evenly across all targets.
Parameters -> (list)
The parameters for a split charge method. This is only required for the
FIXED
method.(structure)
The parameters for a split charge method.
Type -> (string)
The parameter type.
Values -> (list)
The parameter values.
(string)
JSON Syntax:
[
{
"Source": "string",
"Targets": ["string", ...],
"Method": "FIXED"|"PROPORTIONAL"|"EVEN",
"Parameters": [
{
"Type": "ALLOCATION_PERCENTAGES",
"Values": ["string", ...]
}
...
]
}
...
]
--resource-tags
(list)
An optional list of tags to associate with the specified `
CostCategory
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ . You can use resource tags to control access to yourcost category
using IAM policies.Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
The maximum length of a key is 128 characters
The maximum length of a value is 256 characters
Keys and values can only contain alphanumeric characters, spaces, and any of the following:
_.:/=+@-
Keys and values are case sensitive
Keys and values are trimmed for any leading or trailing whitespaces
Don’t use
aws:
as a prefix for your keys. This prefix is reserved for Amazon Web Services use(structure)
The tag structure that contains a tag key and value.
Note
Tagging is supported only for the following Cost Explorer resource types: `
AnomalyMonitor
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , `AnomalySubscription
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , `CostCategory
https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .Key -> (string)
The key that’s associated with the tag.
Value -> (string)
The value that’s associated with the tag.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "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
.
--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.
--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
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.
CostCategoryArn -> (string)
The unique identifier for your newly created Cost Category.
EffectiveStart -> (string)
The Cost Category’s effective start date. It can only be a billing start date (first day of the month).