[ aws . budgets ]

describe-budget-actions-for-account

Description

Describes all of the budget actions for an account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-budget-actions-for-account 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: Actions

Synopsis

  describe-budget-actions-for-account
--account-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The account ID of the user. It should be a 12-digit number.

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

See ‘aws help’ for descriptions of global parameters.

Output

Actions -> (list)

A list of the budget action resources information.

(structure)

A budget action resource.

ActionId -> (string)

A system-generated universally unique identifier (UUID) for the action.

BudgetName -> (string)

A string that represents the budget name. The “:” and “” characters aren’t allowed.

NotificationType -> (string)

The type of a notification. It must be ACTUAL or FORECASTED.

ActionType -> (string)

The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

ActionThreshold -> (structure)

The trigger threshold of the action.

ActionThresholdValue -> (double)

The threshold of a notification.

ActionThresholdType -> (string)

The type of threshold for a notification.

Definition -> (structure)

Where you specify all of the type-specific parameters.

IamActionDefinition -> (structure)

The AWS Identity and Access Management (IAM) action definition details.

PolicyArn -> (string)

The Amazon Resource Name (ARN) of the policy to be attached.

Roles -> (list)

A list of roles to be attached. There must be at least one role.

(string)

Groups -> (list)

A list of groups to be attached. There must be at least one group.

(string)

Users -> (list)

A list of users to be attached. There must be at least one user.

(string)

ScpActionDefinition -> (structure)

The service control policies (SCPs) action definition details.

PolicyId -> (string)

The policy ID attached.

TargetIds -> (list)

A list of target IDs.

(string)

SsmActionDefinition -> (structure)

The AWS Systems Manager (SSM) action definition details.

ActionSubType -> (string)

The action subType.

Region -> (string)

The Region to run the SSM document.

InstanceIds -> (list)

The EC2 and RDS instance IDs.

(string)

ExecutionRoleArn -> (string)

The role passed for action execution and reversion. Roles and actions must be in the same account.

ApprovalModel -> (string)

This specifies if the action needs manual or automatic approval.

Status -> (string)

The status of action.

Subscribers -> (list)

A list of subscribers.

(structure)

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber would have the following parameters:

• A subscriptionType of EMAIL

• An address of example@example.com

SubscriptionType -> (string)

The type of notification that AWS sends to a subscriber.

Address -> (string)

The address that AWS sends budget notifications to, either an SNS topic or an email.

When you create a subscriber, the value of Address can’t contain line breaks.

NextToken -> (string)

A generic string.