[ aws . auditmanager ]
list-assessments¶
Description¶
Returns a list of current and past assessments from Audit Manager.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-assessments
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--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 | --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.
See ‘aws help’ for descriptions of global parameters.
Output¶
assessmentMetadata -> (list)
The metadata that’s associated with the assessment.
(structure)
A metadata object that’s associated with an assessment in Audit Manager.
name -> (string)
The name of the assessment.
id -> (string)
The unique identifier for the assessment.
complianceType -> (string)
The name of the compliance standard that’s related to the assessment, such as PCI-DSS.
status -> (string)
The current status of the assessment.
roles -> (list)
The roles that are associated with the assessment.
(structure)
The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).
roleType -> (string)
The type of customer persona.
Note
In
CreateAssessment,roleTypecan only bePROCESS_OWNER.In
UpdateSettings,roleTypecan only bePROCESS_OWNER.In
BatchCreateDelegationByAssessment,roleTypecan only beRESOURCE_OWNER.roleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role.
delegations -> (list)
The delegations that are associated with the assessment.
(structure)
The assignment of a control set to a delegate for review.
id -> (string)
The unique identifier for the delegation.
assessmentName -> (string)
The name of the assessment that’s associated with the delegation.
assessmentId -> (string)
The identifier for the assessment that’s associated with the delegation.
status -> (string)
The status of the delegation.
roleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role.
roleType -> (string)
The type of customer persona.
Note
In
CreateAssessment,roleTypecan only bePROCESS_OWNER.In
UpdateSettings,roleTypecan only bePROCESS_OWNER.In
BatchCreateDelegationByAssessment,roleTypecan only beRESOURCE_OWNER.creationTime -> (timestamp)
Specifies when the delegation was created.
lastUpdated -> (timestamp)
Specifies when the delegation was last updated.
controlSetId -> (string)
The identifier for the control set that’s associated with the delegation.
comment -> (string)
The comment that’s related to the delegation.
createdBy -> (string)
The IAM user or role that created the delegation.
creationTime -> (timestamp)
Specifies when the assessment was created.
lastUpdated -> (timestamp)
The time of the most recent update.
nextToken -> (string)
The pagination token that’s used to fetch the next set of results.