AWS CLI Command Reference

[ aws . quicksight ]

create-approval-policy

Description

Creates an approval policy in Quick Sight.

See also: AWS API Documentation

Synopsis

  create-approval-policy
--policy-id <value>
--name <value>
[--description <value>]
--actions <value>
--asset-types <value>
--applicable-to <value>
--approval-groups <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]
[--cli-error-format <value>]

Options

--policy-id (string) [required]

The unique identifier to assign to the approval policy. You cannot change this value after you create the policy.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9\-_]+

--name (string) [required]

The name of the approval policy.

Constraints:

  • min: 1
  • max: 256

--description (string)

A description of the approval policy.

Constraints:

  • min: 0
  • max: 1024

--actions (list) [required]

The list of governed actions that trigger the approval workflow.

Constraints:

  • min: 1
  • max: 10

(string)

Possible values:

  • SHARE

Syntax:

"string" "string" ...

--asset-types (list) [required]

The list of asset types that the approval policy applies to.

Constraints:

  • min: 1

(string)

Possible values:

  • AGENT
  • SPACE
  • KNOWLEDGE_BASE

Syntax:

"string" "string" ...

--applicable-to (structure) [required]

The scoping configuration that determines who the approval policy applies to.

Type -> (string) [required]

The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:

  • GROUP : The policy applies only to principals in the groups specified by GroupArns . When you use GROUP , you must also provide a value for GroupArns .

Possible values:

  • GROUP

GroupArns -> (list)

The list of group ARNs that the policy applies to. Required when type is GROUP.

Constraints:

  • min: 1

(string)

Shorthand Syntax:

Type=string,GroupArns=string,string

JSON Syntax:

{
  "Type": "GROUP",
  "GroupArns": ["string", ...]
}

--approval-groups (list) [required]

The list of group ARNs whose members can approve requests.

Constraints:

  • min: 1

(string)

Syntax:

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

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
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Policy -> (structure)

The approval policy that was created.

PolicyId -> (string) [required]

The unique identifier of the approval policy.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9\-_]+

PolicyArn -> (string) [required]

The Amazon Resource Name (ARN) of the approval policy.

Name -> (string) [required]

The name of the approval policy.

Constraints:

  • min: 1
  • max: 256

Description -> (string)

A description of the approval policy.

Constraints:

  • min: 0
  • max: 1024

Actions -> (list) [required]

The list of governed actions that trigger the approval workflow.

Constraints:

  • min: 1
  • max: 10

(string)

Possible values:

  • SHARE

AssetTypes -> (list) [required]

The list of asset types that the approval policy applies to.

Constraints:

  • min: 1

(string)

Possible values:

  • AGENT
  • SPACE
  • KNOWLEDGE_BASE

ApplicableTo -> (structure) [required]

The scoping configuration that determines who the approval policy applies to.

Type -> (string) [required]

The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:

  • GROUP : The policy applies only to principals in the groups specified by GroupArns . When you use GROUP , you must also provide a value for GroupArns .

Possible values:

  • GROUP

GroupArns -> (list)

The list of group ARNs that the policy applies to. Required when type is GROUP.

Constraints:

  • min: 1

(string)

ApprovalGroups -> (list) [required]

The list of group ARNs whose members can approve requests.

Constraints:

  • min: 1

(string)

CreatedAt -> (timestamp) [required]

The date and time that the approval policy was created.

UpdatedAt -> (timestamp) [required]

The date and time that the approval policy was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.