[ aws . securityhub ]
describe-standards-controls¶
Description¶
Returns a list of security standards controls.
For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-standards-controls
--standards-subscription-arn <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--standards-subscription-arn (string)
The ARN of a resource that represents your subscription to a supported standard.
--next-token (string)
The token that is required for pagination. On your first call to the
DescribeStandardsControlsoperation, set the value of this parameter toNULL.For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
--max-results (integer)
The maximum number of security standard controls to return.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To request the list of controls in an enabled standard
The following describe-standards-controls example requests the list of controls in the requestor account’s subscription to the PCI DSS standard. The request returns two controls at a time.
aws securityhub describe-standards-controls \
--standards-subscription-arn "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" \
--max-results 2
Output:
{
"Controls": [
{
"StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1",
"ControlStatus": "ENABLED",
"ControlStatusUpdatedAt": "2020-05-15T18:49:04.473000+00:00",
"ControlId": "PCI.AutoScaling.1",
"Title": "Auto scaling groups associated with a load balancer should use health checks",
"Description": "This AWS control checks whether your Auto Scaling groups that are associated with a load balancer are using Elastic Load Balancing health checks.",
"RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/PCI.AutoScaling.1/remediation",
"SeverityRating": "LOW",
"RelatedRequirements": [
"PCI DSS 2.2"
]
},
{
"StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.CW.1",
"ControlStatus": "ENABLED",
"ControlStatusUpdatedAt": "2020-05-15T18:49:04.498000+00:00",
"ControlId": "PCI.CW.1",
"Title": "A log metric filter and alarm should exist for usage of the \"root\" user",
"Description": "This control checks for the CloudWatch metric filters using the following pattern { $.userIdentity.type = \"Root\" && $.userIdentity.invokedBy NOT EXISTS && $.eventType != \"AwsServiceEvent\" } It checks that the log group name is configured for use with active multi-region CloudTrail, that there is at least one Event Selector for a Trail with IncludeManagementEvents set to true and ReadWriteType set to All, and that there is at least one active subscriber to an SNS topic associated with the alarm.",
"RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/PCI.CW.1/remediation",
"SeverityRating": "MEDIUM",
"RelatedRequirements": [
"PCI DSS 7.2.1"
]
}
],
"NextToken": "U2FsdGVkX1+eNkPoZHVl11ip5HUYQPWSWZGmftcmJiHL8JoKEsCDuaKayiPDyLK+LiTkShveoOdvfxXCkOBaGhohIXhsIedN+LSjQV/l7kfCfJcq4PziNC1N9xe9aq2pjlLVZnznTfSImrodT5bRNHe4fELCQq/z+5ka+5Lzmc11axcwTd5lKgQyQqmUVoeriHZhyIiBgWKf7oNYdBVG8OEortVWvSkoUTt+B2ThcnC7l43kI0UNxlkZ6sc64AsW"
}
For more information, see Viewing details for controls in the AWS Security Hub User Guide.
Output¶
Controls -> (list)
A list of security standards controls.
(structure)
Details for an individual security standard control.
StandardsControlArn -> (string)
The ARN of the security standard control.
ControlStatus -> (string)
The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
DisabledReason -> (string)
The reason provided for the most recent change in status for the control.
ControlStatusUpdatedAt -> (timestamp)
The date and time that the status of the security standard control was most recently updated.
ControlId -> (string)
The identifier of the security standard control.
Title -> (string)
The title of the security standard control.
Description -> (string)
The longer description of the security standard control. Provides information about what the control is checking for.
RemediationUrl -> (string)
A link to remediation information for the control in the Security Hub user documentation.
SeverityRating -> (string)
The severity of findings generated from this security standard control.
The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the issue is detected.
RelatedRequirements -> (list)
The list of requirements that are related to this control.
(string)
NextToken -> (string)
The pagination token to use to request the next page of results.