Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . auditmanager ]

list-assessment-frameworks¶

Description¶

Returns a list of the frameworks that are available in the Audit Manager framework library.

Synopsis¶

  list-assessment-frameworks
--framework-type <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <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>]

Options¶

--framework-type (string)

The type of framework, such as a standard framework or a custom framework.

Possible values:

Standard

Custom

--next-token (string)

The pagination token that's used to fetch the next set of results.

--max-results (integer)

Represents the maximum number of results on a page or for an API request call.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

json
text
table

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

Output¶

frameworkMetadataList -> (list)

A list of metadata that the ListAssessmentFrameworks API returns for each framework.

(structure)

The metadata that's associated with a standard framework or a custom framework.

arn -> (string)

The Amazon Resource Name (ARN) of the framework.

id -> (string)

The unique identifier for the framework.

type -> (string)

The framework type, such as a standard framework or a custom framework.

name -> (string)

The name of the framework.

description -> (string)

The description of the framework.

logo -> (string)

The logo that's associated with the framework.

complianceType -> (string)

The compliance type that the new custom framework supports, such as CIS or HIPAA.

controlsCount -> (integer)

The number of controls that are associated with the framework.

controlSetsCount -> (integer)

The number of control sets that are associated with the framework.

createdAt -> (timestamp)

The time when the framework was created.

lastUpdatedAt -> (timestamp)

The time when the framework was most recently updated.

nextToken -> (string)