2026/11/17 - AWS SecurityHub - 20 updated api methods
Changes Security Hub now supports Google Cloud. Use connector APIs to connect GCP organizations or projects and monitor their security posture. It also infers resource criticality from tags, CloudWatch metrics, and SBOM data to help you prioritize findings
{'StandardsSubscriptions': {'Provider': {'GCP'}}}
Disables the standards specified by the provided StandardsSubscriptionArns.
For more information, see Security Standards section of the Security Hub CSPM User Guide.
See also: AWS API Documentation
Request Syntax
client.batch_disable_standards(
StandardsSubscriptionArns=[
'string',
]
)
list
[REQUIRED]
The ARNs of the standards subscriptions to disable.
(string) --
dict
Response Syntax
{
'StandardsSubscriptions': [
{
'StandardsSubscriptionArn': 'string',
'StandardsArn': 'string',
'StandardsInput': {
'string': 'string'
},
'StandardsStatus': 'PENDING'|'READY'|'FAILED'|'DELETING'|'INCOMPLETE',
'StandardsControlsUpdatable': 'READY_FOR_UPDATES'|'NOT_READY_FOR_UPDATES',
'StandardsStatusReason': {
'StatusReasonCode': 'NO_AVAILABLE_CONFIGURATION_RECORDER'|'MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED'|'NO_AVAILABLE_MULTICLOUD_CONNECTOR'|'INTERNAL_ERROR'
},
'Provider': 'AWS'|'Azure'|'GCP'
},
]
}
Response Structure
(dict) --
StandardsSubscriptions (list) --
The details of the standards subscriptions that were disabled.
(dict) --
A resource that represents your subscription to a supported standard.
StandardsSubscriptionArn (string) --
The ARN of the resource that represents your subscription to the standard.
StandardsArn (string) --
The ARN of the standard.
StandardsInput (dict) --
A key-value pair of input for the standard.
(string) --
(string) --
StandardsStatus (string) --
The status of your subscription to the standard. Possible values are:
PENDING - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub CSPM is adding new controls to the standard.
READY - The standard is enabled.
INCOMPLETE - The standard could not be enabled completely. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to enable the standard.
DELETING - The standard is in the process of being disabled.
FAILED - The standard could not be disabled. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to disable the standard.
StandardsControlsUpdatable (string) --
Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:
READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.
NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.
StandardsStatusReason (dict) --
The reason for the current status.
StatusReasonCode (string) --
The reason code that represents the reason for the current status of a standard subscription.
Provider (string) --
The cloud provider whose resources the standard evaluates. For example, AWS, Azure, or GCP.
{'StandardsSubscriptions': {'Provider': {'GCP'}}}
Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.
For more information, see the Security Standards section of the Security Hub CSPM User Guide.
See also: AWS API Documentation
Request Syntax
client.batch_enable_standards(
StandardsSubscriptionRequests=[
{
'StandardsArn': 'string',
'StandardsInput': {
'string': 'string'
}
},
]
)
list
[REQUIRED]
The list of standards checks to enable.
(dict) --
The standard that you want to enable.
StandardsArn (string) -- [REQUIRED]
The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the DescribeStandards operation.
StandardsInput (dict) --
A key-value pair of input for the standard.
(string) --
(string) --
dict
Response Syntax
{
'StandardsSubscriptions': [
{
'StandardsSubscriptionArn': 'string',
'StandardsArn': 'string',
'StandardsInput': {
'string': 'string'
},
'StandardsStatus': 'PENDING'|'READY'|'FAILED'|'DELETING'|'INCOMPLETE',
'StandardsControlsUpdatable': 'READY_FOR_UPDATES'|'NOT_READY_FOR_UPDATES',
'StandardsStatusReason': {
'StatusReasonCode': 'NO_AVAILABLE_CONFIGURATION_RECORDER'|'MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED'|'NO_AVAILABLE_MULTICLOUD_CONNECTOR'|'INTERNAL_ERROR'
},
'Provider': 'AWS'|'Azure'|'GCP'
},
]
}
Response Structure
(dict) --
StandardsSubscriptions (list) --
The details of the standards subscriptions that were enabled.
(dict) --
A resource that represents your subscription to a supported standard.
StandardsSubscriptionArn (string) --
The ARN of the resource that represents your subscription to the standard.
StandardsArn (string) --
The ARN of the standard.
StandardsInput (dict) --
A key-value pair of input for the standard.
(string) --
(string) --
StandardsStatus (string) --
The status of your subscription to the standard. Possible values are:
PENDING - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub CSPM is adding new controls to the standard.
READY - The standard is enabled.
INCOMPLETE - The standard could not be enabled completely. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to enable the standard.
DELETING - The standard is in the process of being disabled.
FAILED - The standard could not be disabled. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to disable the standard.
StandardsControlsUpdatable (string) --
Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:
READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.
NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.
StandardsStatusReason (dict) --
The reason for the current status.
StatusReasonCode (string) --
The reason code that represents the reason for the current status of a standard subscription.
Provider (string) --
The cloud provider whose resources the standard evaluates. For example, AWS, Azure, or GCP.
{'SecurityControls': {'Provider': {'GCP'}}}
Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.batch_get_security_controls(
SecurityControlIds=[
'string',
]
)
list
[REQUIRED]
A list of security controls (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters). The security control ID or Amazon Resource Name (ARN) is the same across standards.
(string) --
dict
Response Syntax
{
'SecurityControls': [
{
'SecurityControlId': 'string',
'SecurityControlArn': 'string',
'Title': 'string',
'Description': 'string',
'RemediationUrl': 'string',
'SeverityRating': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
'SecurityControlStatus': 'ENABLED'|'DISABLED',
'UpdateStatus': 'READY'|'UPDATING',
'Parameters': {
'string': {
'ValueType': 'DEFAULT'|'CUSTOM',
'Value': {
'Integer': 123,
'IntegerList': [
123,
],
'Double': 123.0,
'String': 'string',
'StringList': [
'string',
],
'Boolean': True|False,
'Enum': 'string',
'EnumList': [
'string',
]
}
}
},
'LastUpdateReason': 'string',
'Provider': 'AWS'|'Azure'|'GCP'
},
],
'UnprocessedIds': [
{
'SecurityControlId': 'string',
'ErrorCode': 'INVALID_INPUT'|'ACCESS_DENIED'|'NOT_FOUND'|'RESOURCE_NOT_FOUND'|'LIMIT_EXCEEDED',
'ErrorReason': 'string'
},
]
}
Response Structure
(dict) --
SecurityControls (list) --
An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. The same information is returned whether the request includes SecurityControlId or SecurityControlArn.
(dict) --
A security control in Security Hub CSPM describes a security best practice related to a specific resource.
SecurityControlId (string) --
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number, such as APIGateway.3.
SecurityControlArn (string) --
The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.
Title (string) --
The title of a security control.
Description (string) --
The description of a security control across standards. This typically summarizes how Security Hub CSPM evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
RemediationUrl (string) --
A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control.
SeverityRating (string) --
The severity of a security control. For more information about how Security Hub CSPM determines control severity, see Assigning severity to control findings in the Security Hub CSPM User Guide.
SecurityControlStatus (string) --
The enablement status of a security control in a specific standard.
UpdateStatus (string) --
Identifies whether customizable properties of a security control are reflected in Security Hub CSPM findings. A status of READY indicates that Security Hub CSPM uses the current control parameter values when running security checks of the control. A status of UPDATING indicates that all security checks might not use the current parameter values.
Parameters (dict) --
An object that identifies the name of a control parameter, its current value, and whether it has been customized.
(string) --
(dict) --
An object that provides the current value of a security control parameter and identifies whether it has been customized.
ValueType (string) --
Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub CSPM behavior.
When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub CSPM default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub CSPM ignores user-provided input for the Value field.
When ValueType is set equal to CUSTOM, the Value field can't be empty.
Value (dict) --
The current value of a control parameter.
Integer (integer) --
A control parameter that is an integer.
IntegerList (list) --
A control parameter that is a list of integers.
(integer) --
Double (float) --
A control parameter that is a double.
String (string) --
A control parameter that is a string.
StringList (list) --
A control parameter that is a list of strings.
(string) --
Boolean (boolean) --
A control parameter that is a boolean.
Enum (string) --
A control parameter that is an enum.
EnumList (list) --
A control parameter that is a list of enums.
(string) --
LastUpdateReason (string) --
The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
Provider (string) --
The cloud provider whose resources the security control evaluates. For example, AWS, Azure, or GCP.
UnprocessedIds (list) --
A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned.
(dict) --
Provides details about a security control for which a response couldn't be returned.
SecurityControlId (string) --
The control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which a response couldn't be returned.
ErrorCode (string) --
The error code for the unprocessed security control. The NOT_FOUND value has been deprecated and replaced by the RESOURCE_NOT_FOUND value.
ErrorReason (string) --
The reason why the security control was unprocessed.
{'Findings': {'Resources': {'Details': {'GcpResource': {}},
'Provider': {'GCP'}}}}
Imports security findings generated by a finding provider into Security Hub CSPM. This action is requested by the finding provider to import its findings into Security Hub CSPM.
BatchImportFindings must be called by one of the following:
The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding.
An Amazon Web Services account that Security Hub CSPM has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub CSPM customers use to manage their investigation workflow.
Note
UserDefinedFields
VerificationState
Workflow
Finding providers also should not use BatchImportFindings to update the following attributes.
Confidence
Criticality
RelatedFindings
Severity
Types
Instead, finding providers use FindingProviderFields to provide values for these attributes.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'FailedCount': 123,
'SuccessCount': 123,
'FailedFindings': [
{
'Id': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedCount (integer) --
The number of findings that failed to import.
SuccessCount (integer) --
The number of findings that were successfully imported.
FailedFindings (list) --
The list of findings that failed to import.
(dict) --
The list of the findings that cannot be imported. For each finding, the list provides the error.
Id (string) --
The identifier of the finding that could not be updated.
ErrorCode (string) --
The code of the error returned by the BatchImportFindings operation.
ErrorMessage (string) --
The message of the error returned by the BatchImportFindings operation.
{'Provider': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Creates a connector to a third-party cloud provider in Security Hub CSPM. A connector establishes a connection between Security Hub CSPM and a third-party cloud provider, enabling Security Hub CSPM to ingest security findings and resource data from the connected environment.
See also: AWS API Documentation
Request Syntax
client.create_connector(
Name='string',
Description='string',
Provider={
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
},
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The name of the connector. Must be unique within the account.
string
The description of the connector.
dict
[REQUIRED]
The configuration for the cloud provider to connect to. Currently supports Azure.
Azure (dict) --
The Azure provider configuration.
AWSConfigConnectorArn (string) -- [REQUIRED]
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) -- [REQUIRED]
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) -- [REQUIRED]
The list of Azure regions to monitor.
(string) --
GCP (dict) --
The GCP provider configuration.
AWSConfigConnectorArn (string) -- [REQUIRED]
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) -- [REQUIRED]
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) -- [REQUIRED]
The list of GCP regions to monitor.
(string) --
A GCP region.
dict
The tags to add to the connector resource.
(string) --
(string) --
string
A unique identifier used to ensure idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}
Response Structure
(dict) --
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
ConnectorId (string) --
The unique identifier of the connector.
ConnectorStatus (string) --
The connectivity status of the connector.
EnablementStatus (string) --
The enablement status of the connector.
{'Provider': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Grants permission to create a connectorV2 based on input parameters.
See also: AWS API Documentation
Request Syntax
client.create_connector_v2(
Name='string',
Description='string',
Provider={
'JiraCloud': {
'ProjectKey': 'string'
},
'ServiceNow': {
'InstanceName': 'string',
'SecretArn': 'string'
},
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
},
KmsKeyArn='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The unique name of the connectorV2.
string
The description of the connectorV2.
dict
[REQUIRED]
The third-party provider’s service configuration.
JiraCloud (dict) --
The configuration settings required to establish an integration with Jira Cloud.
ProjectKey (string) --
The project key for a JiraCloud instance.
ServiceNow (dict) --
The configuration settings required to establish an integration with ServiceNow ITSM.
InstanceName (string) -- [REQUIRED]
The instance name of ServiceNow ITSM.
SecretArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
Azure (dict) --
The configuration settings required to establish a CSPM integration with Microsoft Azure.
AWSConfigConnectorArn (string) -- [REQUIRED]
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) -- [REQUIRED]
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) -- [REQUIRED]
The list of Azure regions to monitor.
(string) --
GCP (dict) --
The configuration settings required to establish a CSPM integration with Google Cloud Platform (GCP).
AWSConfigConnectorArn (string) -- [REQUIRED]
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) -- [REQUIRED]
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) -- [REQUIRED]
The list of GCP regions to monitor.
(string) --
A GCP region.
string
The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.
dict
The tags to add to the connectorV2 when you create.
(string) --
(string) --
string
A unique identifier used to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'AuthUrl': 'string',
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE'
}
Response Structure
(dict) --
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId (string) --
The UUID of the connectorV2 to identify connectorV2 resource.
AuthUrl (string) --
The Url provide to customers for OAuth auth code flow.
ConnectorStatus (string) --
The current status of the connectorV2.
EnablementStatus (string) --
The enablement status of the connector after creation.
{'Providers': {'GCP'}}
Response {'Standards': {'Provider': {'GCP'}}}
Returns a list of the available standards in Security Hub CSPM.
For each standard, the results include the standard ARN, the name, and a description.
See also: AWS API Documentation
Request Syntax
client.describe_standards(
NextToken='string',
MaxResults=123,
Providers=[
'AWS'|'Azure'|'GCP',
]
)
string
The token that is required for pagination. On your first call to the DescribeStandards operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
integer
The maximum number of standards to return.
list
A list of cloud providers to filter the standards by. For example, specify Azure to return only standards that evaluate Azure resources, or GCP to return only standards that evaluate GCP resources.
(string) --
dict
Response Syntax
{
'Standards': [
{
'StandardsArn': 'string',
'Name': 'string',
'Description': 'string',
'EnabledByDefault': True|False,
'Provider': 'AWS'|'Azure'|'GCP',
'StandardsManagedBy': {
'Company': 'string',
'Product': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Standards (list) --
A list of available standards.
(dict) --
Provides information about a specific security standard.
StandardsArn (string) --
The ARN of the standard.
Name (string) --
The name of the standard.
Description (string) --
A description of the standard.
EnabledByDefault (boolean) --
Whether the standard is enabled by default. When Security Hub CSPM is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.
When Security Hub CSPM is enabled using the EnableSecurityHub API operation, the standard is enabled by default unless EnableDefaultStandards is set to false.
Provider (string) --
The cloud provider whose resources the standard evaluates. For example, AWS, Azure, or GCP.
StandardsManagedBy (dict) --
Provides details about the management of a standard.
Company (string) --
An identifier for the company that manages a specific security standard. For existing standards, the value is equal to Amazon Web Services.
Product (string) --
An identifier for the product that manages a specific security standard. For existing standards, the value is equal to the Amazon Web Services service that manages the standard.
NextToken (string) --
The pagination token to use to request the next page of results.
{'ProviderDetail': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Retrieves details for a CSPM connector based on the connector ID.
See also: AWS API Documentation
Request Syntax
client.get_connector(
ConnectorId='string'
)
string
[REQUIRED]
The unique identifier of the connector to retrieve.
dict
Response Syntax
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'Name': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Health': {
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
'Message': 'string',
'LastCheckedAt': datetime(2015, 1, 1),
'Issues': [
{
'Code': 'AUTHENTICATION_FAILURE'|'STREAM_AUTHORIZATION_FAILURE'|'DISCOVERY_FAILURE'|'STREAM_LIMIT_EXCEEDED'|'STREAM_DISCONNECTED'|'RECORDING_FAILURE'|'NO_HEALTH_DATA',
'Message': 'string'
},
]
},
'ProviderDetail': {
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
},
'CreatedBy': 'string',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}
Response Structure
(dict) --
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
ConnectorId (string) --
The unique identifier of the connector.
Name (string) --
The name of the connector.
Description (string) --
The description of the connector.
CreatedAt (datetime) --
The ISO 8601 UTC timestamp indicating when the connector was created.
LastUpdatedAt (datetime) --
The ISO 8601 UTC timestamp indicating when the connector was last updated.
Health (dict) --
The health status of the connector, including connectivity status and last check time.
ConnectorStatus (string) --
The connectivity status of the connector.
Message (string) --
A message describing the reason for the current connector status.
LastCheckedAt (datetime) --
The ISO 8601 UTC timestamp indicating when the health status was last checked.
Issues (list) --
A list of health issues associated with the connector.
(dict) --
Represents a specific health issue detected for a connector.
Code (string) --
The error code that identifies the type of health issue.
Message (string) --
A human-readable message that describes the health issue.
ProviderDetail (dict) --
The cloud provider configuration details for the connector.
Azure (dict) --
The Azure provider detail.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) --
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) --
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) --
The list of Azure regions being monitored.
(string) --
GCP (dict) --
The GCP provider detail.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) --
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) --
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) --
The list of GCP regions being monitored.
(string) --
A GCP region.
CreatedBy (string) --
The service principal that created the connector.
EnablementStatus (string) --
The enablement status of the connector.
{'ProviderDetail': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Grants permission to retrieve details for a connectorV2 based on connector id.
See also: AWS API Documentation
Request Syntax
client.get_connector_v2(
ConnectorId='string'
)
string
[REQUIRED]
The UUID of the connectorV2 to identify connectorV2 resource.
dict
Response Syntax
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'Name': 'string',
'Description': 'string',
'KmsKeyArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Health': {
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
'Message': 'string',
'LastCheckedAt': datetime(2015, 1, 1),
'Issues': [
{
'Code': 'AUTHENTICATION_FAILURE'|'STREAM_AUTHORIZATION_FAILURE'|'DISCOVERY_FAILURE'|'STREAM_LIMIT_EXCEEDED'|'STREAM_DISCONNECTED'|'RECORDING_FAILURE'|'NO_HEALTH_DATA',
'Message': 'string'
},
]
},
'ProviderDetail': {
'JiraCloud': {
'CloudId': 'string',
'ProjectKey': 'string',
'Domain': 'string',
'AuthUrl': 'string',
'AuthStatus': 'ACTIVE'|'FAILED'
},
'ServiceNow': {
'InstanceName': 'string',
'SecretArn': 'string',
'AuthStatus': 'ACTIVE'|'FAILED'
},
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
},
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE',
'EnablementStatusReason': 'string'
}
Response Structure
(dict) --
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId (string) --
The UUID of the connectorV2 to identify connectorV2 resource.
Name (string) --
The name of the connectorV2.
Description (string) --
The description of the connectorV2.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of KMS key used for the connectorV2.
CreatedAt (datetime) --
ISO 8601 UTC timestamp for the time create the connectorV2.
LastUpdatedAt (datetime) --
ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
Health (dict) --
The current health status for connectorV2
ConnectorStatus (string) --
The status of the connectorV2.
Message (string) --
The message for the reason of connectorStatus change.
LastCheckedAt (datetime) --
ISO 8601 UTC timestamp for the time check the health status of the connectorV2.
Issues (list) --
A list of health issues associated with the connector, including error codes and messages.
(dict) --
Represents a specific health issue detected for a connector.
Code (string) --
The error code that identifies the type of health issue.
Message (string) --
A human-readable message that describes the health issue.
ProviderDetail (dict) --
The third-party provider detail for a service configuration.
JiraCloud (dict) --
Details about a Jira Cloud integration.
CloudId (string) --
The cloud id of the Jira Cloud.
ProjectKey (string) --
The projectKey of Jira Cloud.
Domain (string) --
The URL domain of your Jira Cloud instance.
AuthUrl (string) --
The URL to provide to customers for OAuth auth code flow.
AuthStatus (string) --
The status of the authorization between Jira Cloud and the service.
ServiceNow (dict) --
Details about a ServiceNow ITSM integration.
InstanceName (string) --
The instanceName of ServiceNow ITSM.
SecretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
AuthStatus (string) --
The status of the authorization between ServiceNow and the service.
Azure (dict) --
Details about a Microsoft Azure CSPM integration.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) --
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) --
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) --
The list of Azure regions being monitored.
(string) --
GCP (dict) --
Details about a Google Cloud Platform (GCP) CSPM integration.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) --
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) --
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) --
The list of GCP regions being monitored.
(string) --
A GCP region.
EnablementStatus (string) --
The enablement status of the connector.
EnablementStatusReason (string) --
The reason for the current enablement status. Provides additional context when the connector is in a failed state.
{'Providers': {'GCP'}}
Response {'StandardsSubscriptions': {'Provider': {'GCP'}}}
Returns a list of the standards that are currently enabled.
See also: AWS API Documentation
Request Syntax
client.get_enabled_standards(
StandardsSubscriptionArns=[
'string',
],
NextToken='string',
MaxResults=123,
Providers=[
'AWS'|'Azure'|'GCP',
]
)
list
The list of the standards subscription ARNs for the standards to retrieve.
(string) --
string
The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
integer
The maximum number of results to return in the response.
list
A list of cloud providers to filter the enabled standards by. For example, specify Azure to return only enabled standards that evaluate Azure resources, or GCP to return only enabled standards that evaluate GCP resources.
(string) --
dict
Response Syntax
{
'StandardsSubscriptions': [
{
'StandardsSubscriptionArn': 'string',
'StandardsArn': 'string',
'StandardsInput': {
'string': 'string'
},
'StandardsStatus': 'PENDING'|'READY'|'FAILED'|'DELETING'|'INCOMPLETE',
'StandardsControlsUpdatable': 'READY_FOR_UPDATES'|'NOT_READY_FOR_UPDATES',
'StandardsStatusReason': {
'StatusReasonCode': 'NO_AVAILABLE_CONFIGURATION_RECORDER'|'MAXIMUM_NUMBER_OF_CONFIG_RULES_EXCEEDED'|'NO_AVAILABLE_MULTICLOUD_CONNECTOR'|'INTERNAL_ERROR'
},
'Provider': 'AWS'|'Azure'|'GCP'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StandardsSubscriptions (list) --
The list of StandardsSubscriptions objects that include information about the enabled standards.
(dict) --
A resource that represents your subscription to a supported standard.
StandardsSubscriptionArn (string) --
The ARN of the resource that represents your subscription to the standard.
StandardsArn (string) --
The ARN of the standard.
StandardsInput (dict) --
A key-value pair of input for the standard.
(string) --
(string) --
StandardsStatus (string) --
The status of your subscription to the standard. Possible values are:
PENDING - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub CSPM is adding new controls to the standard.
READY - The standard is enabled.
INCOMPLETE - The standard could not be enabled completely. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to enable the standard.
DELETING - The standard is in the process of being disabled.
FAILED - The standard could not be disabled. One or more errors ( StandardsStatusReason) occurred when Security Hub CSPM attempted to disable the standard.
StandardsControlsUpdatable (string) --
Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:
READY_FOR_UPDATES - Controls in the standard can be retrieved and configured.
NOT_READY_FOR_UPDATES - Controls in the standard cannot be retrieved or configured.
StandardsStatusReason (dict) --
The reason for the current status.
StatusReasonCode (string) --
The reason code that represents the reason for the current status of a standard subscription.
Provider (string) --
The cloud provider whose resources the standard evaluates. For example, AWS, Azure, or GCP.
NextToken (string) --
The pagination token to use to request the next page of results.
{'Findings': {'Resources': {'Details': {'GcpResource': {}},
'Provider': {'GCP'}}}}
Returns a list of findings that match the specified criteria.
If cross-Region aggregation is enabled, then when you call GetFindings from the home Region, the results include all of the matching findings from both the home Region and linked Regions.
See also: AWS API Documentation
Request Syntax
client.get_findings(
Filters={
'ProductArn': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'AwsAccountId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Id': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'GeneratorId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Region': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Type': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'FirstObservedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'LastObservedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'CreatedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'UpdatedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'SeverityProduct': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'SeverityNormalized': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'SeverityLabel': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Confidence': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'Criticality': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'Title': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Description': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'RecommendationText': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'SourceUrl': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ProductFields': [
{
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
},
],
'ProductName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'CompanyName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'UserDefinedFields': [
{
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
},
],
'MalwareName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'MalwareType': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'MalwarePath': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'MalwareState': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NetworkDirection': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NetworkProtocol': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NetworkSourceIpV4': [
{
'Cidr': 'string'
},
],
'NetworkSourceIpV6': [
{
'Cidr': 'string'
},
],
'NetworkSourcePort': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'NetworkSourceDomain': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NetworkSourceMac': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NetworkDestinationIpV4': [
{
'Cidr': 'string'
},
],
'NetworkDestinationIpV6': [
{
'Cidr': 'string'
},
],
'NetworkDestinationPort': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'NetworkDestinationDomain': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ProcessName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ProcessPath': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ProcessPid': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'ProcessParentPid': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'ProcessLaunchedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ProcessTerminatedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ThreatIntelIndicatorType': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ThreatIntelIndicatorValue': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ThreatIntelIndicatorCategory': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ThreatIntelIndicatorLastObservedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ThreatIntelIndicatorSource': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ThreatIntelIndicatorSourceUrl': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceType': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourcePartition': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceRegion': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
},
],
'ResourceAwsEc2InstanceType': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceImageId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceIpV4Addresses': [
{
'Cidr': 'string'
},
],
'ResourceAwsEc2InstanceIpV6Addresses': [
{
'Cidr': 'string'
},
],
'ResourceAwsEc2InstanceKeyName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceIamInstanceProfileArn': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceVpcId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceSubnetId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsEc2InstanceLaunchedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ResourceAwsS3BucketOwnerId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsS3BucketOwnerName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsIamAccessKeyUserName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsIamAccessKeyPrincipalName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsIamAccessKeyStatus': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceAwsIamAccessKeyCreatedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ResourceAwsIamUserUserName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceContainerName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceContainerImageId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceContainerImageName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceContainerLaunchedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'ResourceDetailsOther': [
{
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
},
],
'ComplianceStatus': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'VerificationState': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'WorkflowState': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'WorkflowStatus': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'RecordState': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'RelatedFindingsProductArn': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'RelatedFindingsId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NoteText': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'NoteUpdatedAt': [
{
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
},
],
'NoteUpdatedBy': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Keyword': [
{
'Value': 'string'
},
],
'FindingProviderFieldsConfidence': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'FindingProviderFieldsCriticality': [
{
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
},
],
'FindingProviderFieldsRelatedFindingsId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'FindingProviderFieldsRelatedFindingsProductArn': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'FindingProviderFieldsSeverityLabel': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'FindingProviderFieldsSeverityOriginal': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'FindingProviderFieldsTypes': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'Sample': [
{
'Value': True|False
},
],
'ComplianceSecurityControlId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ComplianceAssociatedStandardsId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'VulnerabilitiesExploitAvailable': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'VulnerabilitiesFixAvailable': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ComplianceSecurityControlParametersName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ComplianceSecurityControlParametersValue': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'AwsAccountName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceApplicationName': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceApplicationArn': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceOwnerAccountId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceOwnerOrgId': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
],
'ResourceProvider': [
{
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
},
]
},
SortCriteria=[
{
'Field': 'string',
'SortOrder': 'asc'|'desc'
},
],
NextToken='string',
MaxResults=123
)
**Parameters**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindings>`_
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Items': {'Resource': {'CloudProvider': {'GCP'}}}}
Retrieves remediation targets for the account, or for all member accounts if the caller is the delegated administrator. Results are sorted by priority, highest first, and are paginated. Use TargetUid or MetadataUid to scope the request to a single target or finding.
See also: AWS API Documentation
Request Syntax
client.get_remediations_v2(
TargetUid='string',
MetadataUid='string',
Filters={
'CompositeFilters': [
{
'StringFilters': [
{
'FieldName': 'Resource.Type'|'Priority'|'Status'|'Resource.Id'|'Resource.ResourceOwnerAccountId'|'Resource.CloudProvider',
'Filter': {
'Value': 'string'
}
},
]
},
]
},
ShowGuidance=True|False,
GuidanceFormat='All'|'AwsCli'|'Cli'|'Python'|'Terraform'|'Cdk'|'CloudFormation'|'IaC'|'Template',
MaxResults=123,
NextToken='string'
)
string
The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use TargetUid together with MetadataUid or Filters.
string
The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding. Returns the remediation targets associated with that finding. You can't use MetadataUid together with TargetUid or Filters.
dict
Filters remediation targets based on a set of criteria. You can't use Filters together with TargetUid or MetadataUid.
CompositeFilters (list) --
A collection of complex filtering conditions that can be applied to remediation target data.
(dict) --
Enables the creation of criteria for remediation targets.
StringFilters (list) --
Enables filtering based on string field values.
(dict) --
A string filter for filtering remediation targets.
FieldName (string) -- [REQUIRED]
The name of the filter field. Valid values are Resource.Type, Priority, Status, Resource.Id, Resource.ResourceOwnerAccountId, and Resource.CloudProvider.
Filter (dict) -- [REQUIRED]
The string filter definition.
Value (string) -- [REQUIRED]
The value the string filter is comparing against.
boolean
Specifies whether to show remediation target guidance.
string
The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.
integer
The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.
string
The token used to paginate the remediations target list returned. On your first call to GetRemediationsV2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.
dict
Response Syntax
{
'Items': [
{
'TargetUid': 'string',
'Outcome': {
'ResolvedFindingsCount': 123,
'SeverityReductionFindingsCount': 123,
'SeverityUnchangedCount': 123
},
'Priority': 'Critical'|'High'|'Medium'|'Low',
'RemediationSummary': {
'Action': 'string',
'Description': 'string',
'IsImmediate': True|False,
'PostRemediationSteps': [
'string',
],
'KbArticles': [
{
'Title': 'string',
'Url': 'string'
},
]
},
'Resource': {
'AccountId': 'string',
'Region': 'string',
'ResourceOwnerAccountId': 'string',
'ResourceOwnerOrgId': 'string',
'Type': 'string',
'Name': 'string',
'Id': 'string',
'ResourceGuid': 'string',
'ResourceRegion': 'string',
'CloudProvider': 'Azure'|'AWS'|'GCP'
},
'Status': 'New'|'Updated'|'Resolved',
'Trait': {
'Type': 'string',
'Title': 'string'
},
'Guidance': {
'TargetTypeName': 'string',
'Pattern': 'string',
'Version': 'string',
'Context': {
'ProblemStatement': 'string',
'RiskAssessment': 'string',
'AffectedScope': 'string',
'Prerequisites': [
'string',
]
},
'Specification': {
'Parameters': [
{
'Name': 'string',
'Type': 'string',
'Description': 'string',
'Required': True|False
},
],
'Steps': [
{
'Phase': 'string',
'Description': 'string',
'Service': 'string',
'Action': 'string',
'Logic': 'string',
'Inverse': 'string',
'VerifyAfter': 'string'
},
],
'ExpectedEndState': 'string',
'RequiredPermissions': [
'string',
]
},
'Examples': {
'AwsCli': 'string',
'Cli': 'string',
'Python': 'string',
'Terraform': 'string',
'Cdk': 'string',
'CloudFormation': 'string',
'IaC': 'string',
'Template': 'string'
},
'Metadata': {
'ResourceType': 'string',
'ExposureType': 'string',
'TraitTitles': [
'string',
],
'Reversibility': 'string',
'FixEffect': 'string',
'RiskLevel': 'string',
'AutomationLevel': 'string',
'HumanReviewRequired': True|False,
'GeneratedAt': datetime(2015, 1, 1),
'VerificationStatus': 'string'
}
},
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
An array of remediation targets returned by the operation.
(dict) --
A remediation target.
TargetUid (string) --
The unique identifier (ID) of the remediation target.
Outcome (dict) --
The outcome of the remediation target's resolution.
ResolvedFindingsCount (integer) --
The number of associated exposure findings that are resolved by remediating the target.
SeverityReductionFindingsCount (integer) --
The number of associated exposure findings whose severity is reduced by remediating the target.
SeverityUnchangedCount (integer) --
The number of associated exposure findings whose severity is unchanged by remediating the target.
Priority (string) --
The remediation target's priority. Valid values are Critical, High, Medium, and Low.
RemediationSummary (dict) --
A summary of the remediation target.
Action (string) --
A summarized action to take for the remediation target.
Description (string) --
A description of the remediation target.
IsImmediate (boolean) --
Specifies whether the effect of this target is immediate.
PostRemediationSteps (list) --
An array of steps to be taken after remediation.
(string) --
KbArticles (list) --
An array of KbArticle objects.
(dict) --
A knowledge base article that provides additional guidance related to the remediation target.
Title (string) --
The title of the KbArticle.
Url (string) --
The URL of the KbArticle.
Resource (dict) --
The remediation target's associated resource.
AccountId (string) --
The Amazon Web Services account that recorded the resource data in Security Hub.
Region (string) --
The Amazon Web Services Region in which Security Hub recorded the resource data.
ResourceOwnerAccountId (string) --
The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.
ResourceOwnerOrgId (string) --
The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.
Type (string) --
The type of the resource.
Name (string) --
The name of the resource.
Id (string) --
The unique identifier for a resource.
ResourceGuid (string) --
The global identifier used to identify a resource.
ResourceRegion (string) --
The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.
CloudProvider (string) --
The cloud provider where the resource exists.
AWS specifies that the resource exists in Amazon Web Services.
Azure specifies that the resource exists in Microsoft Azure.
Status (string) --
The current status of the remediation target.
New specifies that the remediation target was newly identified.
Updated specifies that the remediation target changed after it was identified.
Resolved specifies that the remediation target is no longer present.
Trait (dict) --
The trait associated with the remediation target.
Type (string) --
The trait type.
Title (string) --
The trait title.
Guidance (dict) --
The remediation target's guidance. Returned only when ShowGuidance is true in the request.
TargetTypeName (string) --
The name of the remediation target type.
Pattern (string) --
The remediation pattern of the remediation target.
Version (string) --
The guidance version.
Context (dict) --
The context behind the remediation target's existence and guidance.
ProblemStatement (string) --
Explains the cause which directly created the remediation target.
RiskAssessment (string) --
An assessment of the existing risk the remediation target creates.
AffectedScope (string) --
The scope of the resources affected by the resolution of the remediation target.
Prerequisites (list) --
An array of prerequisite steps in resolving the remediation target.
(string) --
Specification (dict) --
The specification of the remediation target guidance. This outlines required resource parameters and permissions, remediation steps, and the end state.
Parameters (list) --
An array of the parameters used in running the steps provided.
(dict) --
A parameter used in running the guidance steps.
Name (string) --
The name of the parameter.
Type (string) --
The type of the parameter.
Description (string) --
A description of the parameter.
Required (boolean) --
Specifies whether the parameter is required for running the guidance steps.
Steps (list) --
An array of ordered steps for resolving the remediation targets.
(dict) --
A step in the remediation guidance.
Phase (string) --
The phase of the remediation plan that this step belongs to (for example, FIX).
Description (string) --
A description of what the step does.
Service (string) --
Which service this step is performed in.
Action (string) --
The action to be taken for this step.
Logic (string) --
The logic behind the existence of this step.
Inverse (string) --
The inverse of the step, to be used if the step needs to be rolled back.
VerifyAfter (string) --
The action to take after the step to verify its success.
ExpectedEndState (string) --
The expected end state of the associated resources after completion of the steps.
RequiredPermissions (list) --
An array of required permissions to run the steps.
(string) --
Examples (dict) --
Provided remediation guidance examples in different formats that can be run for remediating the target.
AwsCli (string) --
An CLI snippet version of the example.
Cli (string) --
A CLI snippet version of the example.
Python (string) --
A Python snippet version of the example.
Terraform (string) --
A Terraform snippet version of the example.
Cdk (string) --
A CDK snippet version of the example.
CloudFormation (string) --
A CloudFormation snippet version of the example.
IaC (string) --
An IaC snippet version of the example.
Template (string) --
A Template snippet version of the example.
Metadata (dict) --
The metadata of the remediation guidance.
ResourceType (string) --
The resource type of the remediation target.
ExposureType (string) --
The exposure type of the related exposure findings.
TraitTitles (list) --
The titles of traits this guidance applies to.
(string) --
Reversibility (string) --
The extent to which changes made in accordance with the guidance can be reversed, for example Fully reversible.
FixEffect (string) --
When the fix takes effect, for example Immediate or Deferred.
RiskLevel (string) --
The risk when implementing the guidance provided.
AutomationLevel (string) --
The extent to which the guidance can be automated, for example Full.
HumanReviewRequired (boolean) --
Specifies whether human review is required.
GeneratedAt (datetime) --
Timestamp of when the guidance was generated.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
VerificationStatus (string) --
Verification status of the guidance.
UpdatedAt (datetime) --
The remediation target's last updated timestamp.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
NextToken (string) --
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
{'Resources': {'CriticalitySources': {'Source': {'CloudWatchTelemetryInference',
'InstalledSoftwareAndPackageInference'}}}}
Returns a list of resources.
You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes.
You can use the Filters parameter to refine results based on resource attributes. You can use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then Filters refines results within that scoped data set.
For AI/ML resources, the response includes the ResourceSubCategory field. For self-hosted AI resources and their host resources, the response also includes ResourceInfo with AI-specific details. Self-hosted AI resources use a ResourceType with the SelfHosted::AI:: prefix, such as SelfHosted::AI::Model, SelfHosted::AI::Agent, SelfHosted::AI::InferenceEndpoint, and SelfHosted::AI::ExternalEndpoint.
If you filter by ResourceSubCategory, you must also include a ResourceCategory string filter with comparison set to EQUALS and value AI/ML in the same request.
See also: AWS API Documentation
Request Syntax
client.get_resources_v2(
Filters={
'CompositeFilters': [
{
'StringFilters': [
{
'FieldName': 'ResourceGuid'|'ResourceId'|'AccountId'|'AccountName'|'Region'|'ResourceProvider'|'ResourceOwnerAccountId'|'ResourceOwnerOrgId'|'ResourceCloudPartition'|'ResourceRegion'|'ResourceCategory'|'ResourceType'|'ResourceName'|'FindingsSummary.FindingType'|'FindingsSummary.ProductName'|'ResourceSubCategory'|'DiscoveryType'|'ResourceInfo.AIDetails.HostResourceGuid'|'ResourceInfo.AIDetails.HostResourceType'|'ResourceInfo.AIDetails.CanonicalId'|'ResourceCriticality',
'Filter': {
'Value': 'string',
'Comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS'|'PREFIX_NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'CONTAINS_WORD'
}
},
],
'DateFilters': [
{
'FieldName': 'ResourceDetailCaptureTime'|'ResourceCreationTime',
'Filter': {
'Start': 'string',
'End': 'string',
'DateRange': {
'Value': 123,
'Unit': 'DAYS',
'Comparison': 'WITHIN'|'OLDER_THAN'
}
}
},
],
'NumberFilters': [
{
'FieldName': 'FindingsSummary.TotalFindings'|'FindingsSummary.Severities.Other'|'FindingsSummary.Severities.Fatal'|'FindingsSummary.Severities.Critical'|'FindingsSummary.Severities.High'|'FindingsSummary.Severities.Medium'|'FindingsSummary.Severities.Low'|'FindingsSummary.Severities.Informational'|'FindingsSummary.Severities.Unknown'|'ResourceInfo.AIDetails.SelfHostedAIModelResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIAgentResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIModelServingResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIExternalEndpointResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIDevelopmentResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIAgentFrameworkResourceCount'|'ResourceInfo.AIDetails.SelfHostedAIAgentToolsAndIdentityResourceCount'|'ResourceInfo.AIDetails.SelfHostedTotalAIResourceCount',
'Filter': {
'Gte': 123.0,
'Lte': 123.0,
'Eq': 123.0,
'Gt': 123.0,
'Lt': 123.0
}
},
],
'MapFilters': [
{
'FieldName': 'ResourceTags',
'Filter': {
'Key': 'string',
'Value': 'string',
'Comparison': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'
}
},
],
'NestedCompositeFilters': {'... recursive ...'},
'Operator': 'AND'|'OR'
},
],
'CompositeOperator': 'AND'|'OR'
},
Scopes={
'AwsOrganizations': [
{
'OrganizationId': 'string',
'OrganizationalUnitId': 'string'
},
]
},
SortCriteria=[
{
'Field': 'string',
'SortOrder': 'asc'|'desc'
},
],
NextToken='string',
MaxResults=123
)
dict
Filters resources based on a set of criteria.
CompositeFilters (list) --
A collection of complex filtering conditions that can be applied to Amazon Web Services resources.
(dict) --
Enables the creation of criteria for Amazon Web Services resources in Security Hub CSPM.
StringFilters (list) --
Enables filtering based on string field values.
(dict) --
Enables filtering of Amazon Web Services resources based on string field values.
FieldName (string) --
The name of the field.
Filter (dict) --
A string filter for filtering Security Hub CSPM findings.
Value (string) --
The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is Security Hub CSPM. If you provide security hub as the filter value, there's no match.
Comparison (string) --
The condition to apply to a string value when filtering Security Hub CSPM findings.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront.
To search for values that contain a word matching the filter value, regardless of case, use CONTAINS_WORD. For example, the filter Title CONTAINS_WORD lambda matches a finding whose Title is GuardDuty Lambda Protection, because the Title contains the word Lambda. Including special characters in the filter value might produce unexpected search results.
To search for values that exactly match the filter value, use EQUALS. For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012.
To search for values that start with the filter value, use PREFIX. For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us. A ResourceRegion that starts with a different value, such as af, ap, or ca, doesn't match.
CONTAINS, EQUALS, and PREFIX filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront, CloudWatch, or both strings in the title.
To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront.
To search for values other than the filter value, use NOT_EQUALS. For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012.
To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS. For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us.
NOT_CONTAINS, NOT_EQUALS, and PREFIX_NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub CSPM first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.
For example, for the following filters, Security Hub CSPM first identifies findings that have resource types that start with either AwsIam or AwsEc2. It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
The CONTAINS operator works with automation rules V1 and V2. The NOT_CONTAINS operator works only with automation rules V1. The CONTAINS_WORD operator works only in the GetFindingsV2, GetFindingStatisticsV2, GetResourcesV2, and GetResourcesStatisticsV2 APIs. For more information, see Automation rules in the Security Hub CSPM User Guide.
DateFilters (list) --
Enables filtering based on date and timestamp field values.
(dict) --
Enables the filtering of Amazon Web Services resources based on date and timestamp attributes.
FieldName (string) --
The name of the field.
Filter (dict) --
A date filter for querying findings.
Start (string) --
A timestamp that provides the start date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
End (string) --
A timestamp that provides the end date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
DateRange (dict) --
A date range for the date filter.
Value (integer) --
A date range value for the date filter.
Unit (string) --
A date range unit for the date filter.
Comparison (string) --
The condition to apply to a date range filter. If you specify WITHIN, Security Hub filters for dates within the specified date range. If you specify OLDER_THAN, Security Hub filters for dates before the specified date range. If you don't specify a value, the default is WITHIN.
NumberFilters (list) --
Enables filtering based on numerical field values.
(dict) --
Enables filtering of Amazon Web Services resources based on numerical values.
FieldName (string) --
The name of the field.
Filter (dict) --
A number filter for querying findings.
Gte (float) --
The greater-than-equal condition to be applied to a single field when querying for findings.
Lte (float) --
The less-than-equal condition to be applied to a single field when querying for findings.
Eq (float) --
The equal-to condition to be applied to a single field when querying for findings.
Gt (float) --
The greater-than condition to be applied to a single field when querying for findings.
Lt (float) --
The less-than condition to be applied to a single field when querying for findings.
MapFilters (list) --
Enables filtering based on map-based field values.
(dict) --
Enables filtering of Amazon Web Services resources based on key-value map attributes.
FieldName (string) --
The name of the field.
Filter (dict) --
A map filter for filtering Security Hub CSPM findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.
Key (string) --
The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, Key is the name of the field.
Value (string) --
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security. If you provide security as the filter value, then there's no match.
Comparison (string) --
The condition to apply to the key value when filtering Security Hub CSPM findings with a map filter.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match.
To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag.
CONTAINS and EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security, Finance, or both values.
To search for values that don't have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag.
To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag.
NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values.
CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error.
CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub CSPM User Guide.
NestedCompositeFilters (list) --
Provides an additional level of filtering, creating a three-layer nested structure. The first layer is a CompositeFilters array with a CompositeOperator ( AND/ OR). The second layer is a CompositeFilter object that contains direct filters and NestedCompositeFilters. The third layer is NestedCompositeFilters, which contains additional filter conditions.
Operator (string) --
The logical operator used to combine multiple filter conditions.
CompositeOperator (string) --
The logical operator used to combine multiple filter conditions in the structure.
dict
Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.
This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.
You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.
AwsOrganizations (list) --
A list of Organizations scopes to include in the query results. Each entry in the list specifies an organization or organizational unit to include for the delegated administrator's account. If the list specifies multiple entries, the entries are combined using OR logic.
(dict) --
Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.
To scope to a specific organizational unit, provide OrganizationalUnitId. You can optionally include OrganizationId. If you omit OrganizationId, Security Hub uses the caller's organization ID. To scope to the delegated administrator's entire organization, provide only OrganizationId.
The organization ID and organizational unit must belong to the delegated administrator's own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId, or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId. You can't combine both approaches in the same request.
OrganizationId (string) --
The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.
OrganizationalUnitId (string) --
The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.
list
The resource attributes used to sort the list of returned resources.
(dict) --
A collection of finding attributes used to sort findings.
Field (string) --
The finding attribute used to sort findings.
SortOrder (string) --
The order used to sort findings.
string
The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
integer
The maximum number of results to return.
dict
Response Syntax
{
'Resources': [
{
'ResourceGuid': 'string',
'ResourceId': 'string',
'AccountId': 'string',
'AccountName': 'string',
'Region': 'string',
'ResourceProvider': 'string',
'ResourceOwnerAccountId': 'string',
'ResourceOwnerOrgId': 'string',
'ResourceCloudPartition': 'string',
'ResourceRegion': 'string',
'ResourceCategory': 'Compute'|'Database'|'Storage'|'Code'|'AI/ML'|'Identity'|'Network'|'Messaging'|'Other',
'ResourceType': 'string',
'ResourceName': 'string',
'ResourceCreationTimeDt': 'string',
'ResourceDetailCaptureTimeDt': 'string',
'FindingsSummary': [
{
'FindingType': 'string',
'ProductName': 'string',
'TotalFindings': 123,
'Severities': {
'Other': 123,
'Fatal': 123,
'Critical': 123,
'High': 123,
'Medium': 123,
'Low': 123,
'Informational': 123,
'Unknown': 123
}
},
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ResourceConfig': {...}|[...]|123|123.4|'string'|True|None,
'ResourceSubCategory': 'Model'|'ModelServing'|'Agent'|'AgentFramework'|'AgentToolsAndIdentity'|'SafetyAndGuardrail'|'KnowledgeAndData'|'OrchestrationAndPipeline'|'ExternalEndpoint'|'Development'|'Other',
'DiscoveryType': 'Managed'|'SelfHosted',
'ResourceInfo': {
'AIDetails': {
'HostResourceGuid': 'string',
'HostResourceType': 'string',
'CanonicalId': 'string',
'SelfHostedAIModelResourceCount': 123,
'SelfHostedAIAgentResourceCount': 123,
'SelfHostedAIModelServingResourceCount': 123,
'SelfHostedAIExternalEndpointResourceCount': 123,
'SelfHostedAIDevelopmentResourceCount': 123,
'SelfHostedAIAgentFrameworkResourceCount': 123,
'SelfHostedAIAgentToolsAndIdentityResourceCount': 123,
'SelfHostedTotalAIResourceCount': 123
}
},
'ResourceCriticality': 'Very High'|'High'|'Medium'|'Low'|'Unknown',
'CriticalitySources': [
{
'Source': 'AutomationRule'|'ResourceName'|'TagInference'|'CloudWatchTelemetryInference'|'InstalledSoftwareAndPackageInference',
'Reason': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Resources (list) --
An array of resources returned by the operation.
(dict) --
Provides comprehensive details about an Amazon Web Services resource and its associated security findings.
ResourceGuid (string) --
The global identifier used to identify a resource.
ResourceId (string) --
The unique identifier for a resource.
AccountId (string) --
The Amazon Web Services account that recorded the resource data in Security Hub.
AccountName (string) --
The name of the Amazon Web Services account that's associated with the resource.
Region (string) --
The Amazon Web Services Region that recorded the resource data in Security Hub.
ResourceProvider (string) --
The cloud provider where the resource exists. Valid values are AWS and Azure. This field is always included.
ResourceOwnerAccountId (string) --
The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.
ResourceOwnerOrgId (string) --
The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.
ResourceCloudPartition (string) --
The cloud partition where the resource exists. For Amazon Web Services, valid values include aws, aws-cn, and aws-us-gov. This field isn't returned for cloud providers that don't use partitions.
ResourceRegion (string) --
The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.
ResourceCategory (string) --
The grouping where the resource belongs.
ResourceType (string) --
The type of resource.
ResourceName (string) --
The name of the resource.
ResourceCreationTimeDt (string) --
The time when the resource was created.
ResourceDetailCaptureTimeDt (string) --
The timestamp when information about the resource was captured.
FindingsSummary (list) --
An aggregated view of security findings associated with a resource.
(dict) --
A list of summaries for all finding types on a resource.
FindingType (string) --
The category or classification of the security finding.
ProductName (string) --
The name of the product associated with the security finding.
TotalFindings (integer) --
The total count of security findings.
Severities (dict) --
A breakdown of security findings by their severity levels.
Other (integer) --
The number of findings not in any of the severity categories.
Fatal (integer) --
The number of findings with a severity level of fatal.
Critical (integer) --
The number of findings with a severity level of critical.
High (integer) --
The number of findings with a severity level of high.
Medium (integer) --
The number of findings with a severity level of medium.
Low (integer) --
The number of findings with a severity level of low.
Informational (integer) --
The number of findings that provide security-related information.
Unknown (integer) --
The number of findings with a severity level cannot be determined.
ResourceTags (list) --
The key-value pairs associated with a resource.
(dict) --
Represents tag information associated with Amazon Web Services resources.
Key (string) --
The identifier or name of the tag.
Value (string) --
The data associated with the tag key.
ResourceConfig (:ref:`document<document>`) --
The configuration details of a resource.
ResourceSubCategory (string) --
The AI/ML sub-grouping of the resource. Present only when ResourceCategory is AI/ML.
DiscoveryType (string) --
Specifies how the resource was discovered. If the value is Managed, the resource is natively provided by a cloud service provider. If the value is SelfHosted, the resource is hosted on customer-managed infrastructure, such as a compute instance or container image.
ResourceInfo (dict) --
Additional resource-type-specific details. For self-hosted AI resources and their host resources, contains an AIDetails structure.
AIDetails (dict) --
Details that are specific to self-hosted AI resources and their host resources.
HostResourceGuid (string) --
The identifier of the host resource that hosts the self-hosted AI resource. Present only on self-hosted AI resources.
HostResourceType (string) --
The ResourceType of the host resource that hosts the self-hosted AI resource, such as AWS::EC2::Instance. Present only on self-hosted AI resources.
CanonicalId (string) --
The canonical identifier for the AI resource, independent of where it is deployed. Multiple occurrences of the same resource on different hosts share the same CanonicalId. For model resources, the value follows the format model/<purl>, such as model/pkg:huggingface/meta-llama/llama-3-8b. Present only on self-hosted AI resources.
SelfHostedAIModelResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory Model detected on the host resource. Present only on host resources.
SelfHostedAIAgentResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory Agent detected on the host resource. Present only on host resources.
SelfHostedAIModelServingResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory ModelServing detected on the host resource. Present only on host resources.
SelfHostedAIExternalEndpointResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory ExternalEndpoint detected on the host resource. Present only on host resources.
SelfHostedAIDevelopmentResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory Development detected on the host resource. Present only on host resources.
SelfHostedAIAgentFrameworkResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory AgentFramework detected on the host resource. Present only on host resources.
SelfHostedAIAgentToolsAndIdentityResourceCount (integer) --
The number of self-hosted AI resources of ResourceSubCategory AgentToolsAndIdentity detected on the host resource. Present only on host resources.
SelfHostedTotalAIResourceCount (integer) --
The total number of all self-hosted AI resources detected on the host resource. Present only on host resources.
ResourceCriticality (string) --
The criticality assigned to a resource.
CriticalitySources (list) --
The sources of criticalities determined from a resource.
(dict) --
Details the source and reason of a criticality.
Source (string) --
The source of the criticality.
Reason (string) --
The reason the criticality was assigned.
NextToken (string) --
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
{'SecurityControlDefinition': {'Provider': {'GCP'}}}
Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
See also: AWS API Documentation
Request Syntax
client.get_security_control_definition(
SecurityControlId='string'
)
string
[REQUIRED]
The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).
dict
Response Syntax
{
'SecurityControlDefinition': {
'SecurityControlId': 'string',
'Title': 'string',
'Description': 'string',
'RemediationUrl': 'string',
'SeverityRating': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
'CurrentRegionAvailability': 'AVAILABLE'|'UNAVAILABLE',
'CustomizableProperties': [
'Parameters',
],
'ParameterDefinitions': {
'string': {
'Description': 'string',
'ConfigurationOptions': {
'Integer': {
'DefaultValue': 123,
'Min': 123,
'Max': 123
},
'IntegerList': {
'DefaultValue': [
123,
],
'Min': 123,
'Max': 123,
'MaxItems': 123
},
'Double': {
'DefaultValue': 123.0,
'Min': 123.0,
'Max': 123.0
},
'String': {
'DefaultValue': 'string',
'Re2Expression': 'string',
'ExpressionDescription': 'string'
},
'StringList': {
'DefaultValue': [
'string',
],
'Re2Expression': 'string',
'MaxItems': 123,
'ExpressionDescription': 'string'
},
'Boolean': {
'DefaultValue': True|False
},
'Enum': {
'DefaultValue': 'string',
'AllowedValues': [
'string',
]
},
'EnumList': {
'DefaultValue': [
'string',
],
'MaxItems': 123,
'AllowedValues': [
'string',
]
}
}
}
},
'Provider': 'AWS'|'Azure'|'GCP'
}
}
Response Structure
(dict) --
SecurityControlDefinition (dict) --
Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.
SecurityControlId (string) --
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
Title (string) --
The title of a security control.
Description (string) --
The description of a security control across standards. This typically summarizes how Security Hub CSPM evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
RemediationUrl (string) --
A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control.
SeverityRating (string) --
The severity of a security control. For more information about how Security Hub CSPM determines control severity, see Assigning severity to control findings in the Security Hub CSPM User Guide.
CurrentRegionAvailability (string) --
Specifies whether a security control is available in the current Amazon Web Services Region.
CustomizableProperties (list) --
Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.
(string) --
ParameterDefinitions (dict) --
An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.
(string) --
(dict) --
An object that describes a security control parameter and the options for customizing it.
Description (string) --
Description of a control parameter.
ConfigurationOptions (dict) --
The options for customizing a control parameter. Customization options vary based on the data type of the parameter.
Integer (dict) --
The options for customizing a security control parameter that is an integer.
DefaultValue (integer) --
The Security Hub CSPM default value for a control parameter that is an integer.
Min (integer) --
The minimum valid value for a control parameter that is an integer.
Max (integer) --
The maximum valid value for a control parameter that is an integer.
IntegerList (dict) --
The options for customizing a security control parameter that is a list of integers.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of integers.
(integer) --
Min (integer) --
The minimum valid value for a control parameter that is a list of integers.
Max (integer) --
The maximum valid value for a control parameter that is a list of integers.
MaxItems (integer) --
The maximum number of list items that an interger list control parameter can accept.
Double (dict) --
The options for customizing a security control parameter that is a double.
DefaultValue (float) --
The Security Hub CSPM default value for a control parameter that is a double.
Min (float) --
The minimum valid value for a control parameter that is a double.
Max (float) --
The maximum valid value for a control parameter that is a double.
String (dict) --
The options for customizing a security control parameter that is a string data type.
DefaultValue (string) --
The Security Hub CSPM default value for a control parameter that is a string.
Re2Expression (string) --
An RE2 regular expression that Security Hub CSPM uses to validate a user-provided control parameter string.
ExpressionDescription (string) --
The description of the RE2 regular expression.
StringList (dict) --
The options for customizing a security control parameter that is a list of strings.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of strings.
(string) --
Re2Expression (string) --
An RE2 regular expression that Security Hub CSPM uses to validate a user-provided list of strings for a control parameter.
MaxItems (integer) --
The maximum number of list items that a string list control parameter can accept.
ExpressionDescription (string) --
The description of the RE2 regular expression.
Boolean (dict) --
The options for customizing a security control parameter that is a boolean. For a boolean parameter, the options are true and false.
DefaultValue (boolean) --
The Security Hub CSPM default value for a boolean parameter.
Enum (dict) --
The options for customizing a security control parameter that is an enum.
DefaultValue (string) --
The Security Hub CSPM default value for a control parameter that is an enum.
AllowedValues (list) --
The valid values for a control parameter that is an enum.
(string) --
EnumList (dict) --
The options for customizing a security control parameter that is a list of enums.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of enums.
(string) --
MaxItems (integer) --
The maximum number of list items that an enum list control parameter can accept.
AllowedValues (list) --
The valid values for a control parameter that is a list of enums.
(string) --
Provider (string) --
The cloud provider whose resources the security control evaluates. For example, AWS, Azure, or GCP.
{'ProviderName': {'GCP'}}
Response {'Connectors': {'ProviderSummary': {'ProviderConfiguration': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT '
'| '
'ORGANIZATION',
'ScopeValues': ['string']}}},
'ProviderName': {'GCP'}}}}
Lists the CSPM connectors and their metadata for the calling account.
See also: AWS API Documentation
Request Syntax
client.list_connectors(
NextToken='string',
MaxResults=123,
ProviderName='AZURE'|'GCP',
ConnectorStatus='CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
EnablementStatus='ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
)
string
The pagination token to request the next page of results.
integer
The maximum number of results to return.
string
The name of the cloud provider to filter connectors by.
string
The connectivity status to filter connectors by.
string
The enablement status to filter connectors by.
dict
Response Syntax
{
'NextToken': 'string',
'Connectors': [
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'Name': 'string',
'Description': 'string',
'ProviderSummary': {
'ProviderName': 'AZURE'|'GCP',
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
'ProviderConfiguration': {
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'CreatedBy': 'string',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to use to request the next page of results. If there are no additional results, this value is null.
Connectors (list) --
An array of connector summaries.
(dict) --
A summary of a CSPM connector.
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
ConnectorId (string) --
The unique identifier of the connector.
Name (string) --
The name of the connector.
Description (string) --
The description of the connector.
ProviderSummary (dict) --
A summary of the cloud provider configuration for the connector.
ProviderName (string) --
The name of the cloud provider.
ConnectorStatus (string) --
The connectivity status of the connector.
ProviderConfiguration (dict) --
The provider configuration details.
Azure (dict) --
The Azure provider detail.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) --
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) --
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) --
The list of Azure regions being monitored.
(string) --
GCP (dict) --
The GCP provider detail.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) --
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) --
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) --
The list of GCP regions being monitored.
(string) --
A GCP region.
CreatedAt (datetime) --
The ISO 8601 UTC timestamp indicating when the connector was created.
CreatedBy (string) --
The service principal that created the connector.
EnablementStatus (string) --
The enablement status of the connector.
{'ProviderName': {'GCP'}}
Response {'Connectors': {'ProviderSummary': {'ProviderConfiguration': {'GCP': {'AWSConfigConnectorArn': 'string',
'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT '
'| '
'ORGANIZATION',
'ScopeValues': ['string']}}},
'ProviderName': {'GCP'}}}}
Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account.
See also: AWS API Documentation
Request Syntax
client.list_connectors_v2(
NextToken='string',
MaxResults=123,
ProviderName='JIRA_CLOUD'|'SERVICENOW'|'AZURE'|'GCP',
ConnectorStatus='CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
EnablementStatus='ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE'
)
string
The pagination token per the Amazon Web Services Pagination standard
integer
The maximum number of results to be returned.
string
The name of the third-party provider.
string
The status for the connectorV2.
string
The enablement status to filter connectors by.
dict
Response Syntax
{
'NextToken': 'string',
'Connectors': [
{
'ConnectorArn': 'string',
'ConnectorId': 'string',
'Name': 'string',
'Description': 'string',
'ProviderSummary': {
'ProviderName': 'JIRA_CLOUD'|'SERVICENOW'|'AZURE'|'GCP',
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
'ProviderConfiguration': {
'JiraCloud': {
'CloudId': 'string',
'ProjectKey': 'string',
'Domain': 'string',
'AuthUrl': 'string',
'AuthStatus': 'ACTIVE'|'FAILED'
},
'ServiceNow': {
'InstanceName': 'string',
'SecretArn': 'string',
'AuthStatus': 'ACTIVE'|'FAILED'
},
'Azure': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'AWSConfigConnectorArn': 'string',
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE',
'EnablementStatusReason': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
Connectors (list) --
An array of connectorV2 summaries.
(dict) --
A condensed overview of the connectorV2..
ConnectorArn (string) --
The Amazon Resource Name (ARN) of the connectorV2.
ConnectorId (string) --
The UUID of the connectorV2 to identify connectorV2 resource.
Name (string) --
The Name field contains the user-defined name assigned to the integration connector. This helps identify and manage multiple connectors within Security Hub.
Description (string) --
The description of the connectorV2.
ProviderSummary (dict) --
The connectorV2 third party provider configuration summary.
ProviderName (string) --
The name of the provider.
ConnectorStatus (string) --
The status for the connectorV2.
ProviderConfiguration (dict) --
The third-party provider detail for a service configuration.
JiraCloud (dict) --
Details about a Jira Cloud integration.
CloudId (string) --
The cloud id of the Jira Cloud.
ProjectKey (string) --
The projectKey of Jira Cloud.
Domain (string) --
The URL domain of your Jira Cloud instance.
AuthUrl (string) --
The URL to provide to customers for OAuth auth code flow.
AuthStatus (string) --
The status of the authorization between Jira Cloud and the service.
ServiceNow (dict) --
Details about a ServiceNow ITSM integration.
InstanceName (string) --
The instanceName of ServiceNow ITSM.
SecretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
AuthStatus (string) --
The status of the authorization between ServiceNow and the service.
Azure (dict) --
Details about a Microsoft Azure CSPM integration.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
ScopeConfiguration (dict) --
The scope configuration that defines which Azure resources are monitored.
ScopeType (string) --
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) --
The list of Azure regions being monitored.
(string) --
GCP (dict) --
Details about a Google Cloud Platform (GCP) CSPM integration.
AWSConfigConnectorArn (string) --
The ARN of the multi-cloud configuration connector used to establish the connection to GCP.
ScopeConfiguration (dict) --
The scope configuration that defines which GCP resources are monitored.
ScopeType (string) --
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) --
The list of GCP regions being monitored.
(string) --
A GCP region.
CreatedAt (datetime) --
ISO 8601 UTC timestamp for the time create the connectorV2.
EnablementStatus (string) --
The enablement status of the connector.
EnablementStatusReason (string) --
The reason for the current enablement status. Provides additional context when the connector is in a failed state.
{'Resource': {'CloudProvider': {'GCP'}}}
Retrieves the exposure findings tied to a specific remediation target. Results are sorted by previous severity, highest first, and are paginated.
See also: AWS API Documentation
Request Syntax
client.list_exposures_by_remediation_v2(
TargetUid='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier (ID) of an existing remediation target to list exposure findings for.
integer
The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.
string
The token used to paginate the exposures list returned. On your first call to ListExposuresByRemediationV2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.
dict
Response Syntax
{
'Items': [
{
'MetadataUid': 'string',
'Title': 'string',
'PreviousSeverity': 'Informational'|'Low'|'Medium'|'High'|'Critical',
'ProjectedSeverity': 'Informational'|'Low'|'Medium'|'High'|'Critical',
'Impact': 'Reduces'|'Resolves'|'Unchanged'
},
],
'TargetUid': 'string',
'Resource': {
'AccountId': 'string',
'Region': 'string',
'ResourceOwnerAccountId': 'string',
'ResourceOwnerOrgId': 'string',
'Type': 'string',
'Name': 'string',
'Id': 'string',
'ResourceGuid': 'string',
'ResourceRegion': 'string',
'CloudProvider': 'Azure'|'AWS'|'GCP'
},
'TotalCount': 123,
'Trait': {
'Type': 'string',
'Title': 'string'
},
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
An array of exposure findings returned by the operation.
(dict) --
Provides details about an exposure finding and the effect the specific remediation target has on it.
MetadataUid (string) --
The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding.
Title (string) --
The title of the exposure finding.
PreviousSeverity (string) --
The severity of the exposure finding before the remediation target is resolved.
ProjectedSeverity (string) --
The severity of the exposure finding after the remediation target is resolved.
Impact (string) --
The impact resolving a remediation target has on the exposure finding.
Reduces specifies that resolving the remediation target lowers the severity of the exposure finding, but does not resolve it.
Resolves specifies that resolving the remediation target resolves the exposure finding.
Unchanged specifies that resolving the remediation target does not change the severity of the exposure finding.
TargetUid (string) --
The unique identifier (ID) of the remediation target that the exposure findings are associated with.
Resource (dict) --
Provides comprehensive details about a resource.
AccountId (string) --
The Amazon Web Services account that recorded the resource data in Security Hub.
Region (string) --
The Amazon Web Services Region in which Security Hub recorded the resource data.
ResourceOwnerAccountId (string) --
The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.
ResourceOwnerOrgId (string) --
The identifier of the cloud organization that owns the resource. For Amazon Web Services resources, this is the Organizations ID. For Azure resources, this is the Azure tenant ID.
Type (string) --
The type of the resource.
Name (string) --
The name of the resource.
Id (string) --
The unique identifier for a resource.
ResourceGuid (string) --
The global identifier used to identify a resource.
ResourceRegion (string) --
The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2). This field is always included.
CloudProvider (string) --
The cloud provider where the resource exists.
AWS specifies that the resource exists in Amazon Web Services.
Azure specifies that the resource exists in Microsoft Azure.
TotalCount (integer) --
The total count of exposure findings associated with the remediation target.
Trait (dict) --
The specific trait associated with the remediation target.
Type (string) --
The trait type.
Title (string) --
The trait title.
NextToken (string) --
The pagination token to use to request the next page of results. Otherwise, this parameter is null.
{'Providers': {'GCP'}}
Response {'SecurityControlDefinitions': {'Provider': {'GCP'}}}
Lists all of the security controls that apply to a specified standard.
See also: AWS API Documentation
Request Syntax
client.list_security_control_definitions(
StandardsArn='string',
NextToken='string',
MaxResults=123,
Providers=[
'AWS'|'Azure'|'GCP',
]
)
string
The Amazon Resource Name (ARN) of the standard that you want to view controls for.
string
Optional pagination parameter.
integer
An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned.
list
A list of cloud providers to filter the security control definitions by. For example, specify Azure to return only controls that evaluate Azure resources, or GCP to return only controls that evaluate GCP resources.
(string) --
dict
Response Syntax
{
'SecurityControlDefinitions': [
{
'SecurityControlId': 'string',
'Title': 'string',
'Description': 'string',
'RemediationUrl': 'string',
'SeverityRating': 'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
'CurrentRegionAvailability': 'AVAILABLE'|'UNAVAILABLE',
'CustomizableProperties': [
'Parameters',
],
'ParameterDefinitions': {
'string': {
'Description': 'string',
'ConfigurationOptions': {
'Integer': {
'DefaultValue': 123,
'Min': 123,
'Max': 123
},
'IntegerList': {
'DefaultValue': [
123,
],
'Min': 123,
'Max': 123,
'MaxItems': 123
},
'Double': {
'DefaultValue': 123.0,
'Min': 123.0,
'Max': 123.0
},
'String': {
'DefaultValue': 'string',
'Re2Expression': 'string',
'ExpressionDescription': 'string'
},
'StringList': {
'DefaultValue': [
'string',
],
'Re2Expression': 'string',
'MaxItems': 123,
'ExpressionDescription': 'string'
},
'Boolean': {
'DefaultValue': True|False
},
'Enum': {
'DefaultValue': 'string',
'AllowedValues': [
'string',
]
},
'EnumList': {
'DefaultValue': [
'string',
],
'MaxItems': 123,
'AllowedValues': [
'string',
]
}
}
}
},
'Provider': 'AWS'|'Azure'|'GCP'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityControlDefinitions (list) --
An array of controls that apply to the specified standard.
(dict) --
Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.
SecurityControlId (string) --
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
Title (string) --
The title of a security control.
Description (string) --
The description of a security control across standards. This typically summarizes how Security Hub CSPM evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
RemediationUrl (string) --
A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control.
SeverityRating (string) --
The severity of a security control. For more information about how Security Hub CSPM determines control severity, see Assigning severity to control findings in the Security Hub CSPM User Guide.
CurrentRegionAvailability (string) --
Specifies whether a security control is available in the current Amazon Web Services Region.
CustomizableProperties (list) --
Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.
(string) --
ParameterDefinitions (dict) --
An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.
(string) --
(dict) --
An object that describes a security control parameter and the options for customizing it.
Description (string) --
Description of a control parameter.
ConfigurationOptions (dict) --
The options for customizing a control parameter. Customization options vary based on the data type of the parameter.
Integer (dict) --
The options for customizing a security control parameter that is an integer.
DefaultValue (integer) --
The Security Hub CSPM default value for a control parameter that is an integer.
Min (integer) --
The minimum valid value for a control parameter that is an integer.
Max (integer) --
The maximum valid value for a control parameter that is an integer.
IntegerList (dict) --
The options for customizing a security control parameter that is a list of integers.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of integers.
(integer) --
Min (integer) --
The minimum valid value for a control parameter that is a list of integers.
Max (integer) --
The maximum valid value for a control parameter that is a list of integers.
MaxItems (integer) --
The maximum number of list items that an interger list control parameter can accept.
Double (dict) --
The options for customizing a security control parameter that is a double.
DefaultValue (float) --
The Security Hub CSPM default value for a control parameter that is a double.
Min (float) --
The minimum valid value for a control parameter that is a double.
Max (float) --
The maximum valid value for a control parameter that is a double.
String (dict) --
The options for customizing a security control parameter that is a string data type.
DefaultValue (string) --
The Security Hub CSPM default value for a control parameter that is a string.
Re2Expression (string) --
An RE2 regular expression that Security Hub CSPM uses to validate a user-provided control parameter string.
ExpressionDescription (string) --
The description of the RE2 regular expression.
StringList (dict) --
The options for customizing a security control parameter that is a list of strings.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of strings.
(string) --
Re2Expression (string) --
An RE2 regular expression that Security Hub CSPM uses to validate a user-provided list of strings for a control parameter.
MaxItems (integer) --
The maximum number of list items that a string list control parameter can accept.
ExpressionDescription (string) --
The description of the RE2 regular expression.
Boolean (dict) --
The options for customizing a security control parameter that is a boolean. For a boolean parameter, the options are true and false.
DefaultValue (boolean) --
The Security Hub CSPM default value for a boolean parameter.
Enum (dict) --
The options for customizing a security control parameter that is an enum.
DefaultValue (string) --
The Security Hub CSPM default value for a control parameter that is an enum.
AllowedValues (list) --
The valid values for a control parameter that is an enum.
(string) --
EnumList (dict) --
The options for customizing a security control parameter that is a list of enums.
DefaultValue (list) --
The Security Hub CSPM default value for a control parameter that is a list of enums.
(string) --
MaxItems (integer) --
The maximum number of list items that an enum list control parameter can accept.
AllowedValues (list) --
The valid values for a control parameter that is a list of enums.
(string) --
Provider (string) --
The cloud provider whose resources the security control evaluates. For example, AWS, Azure, or GCP.
NextToken (string) --
A pagination parameter that's included in the response only if it was included in the request.
{'Provider': {'GCP': {'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Updates a CSPM connector's configuration, such as the scope or regions for the connected cloud provider.
See also: AWS API Documentation
Request Syntax
client.update_connector(
ConnectorId='string',
Description='string',
Provider={
'Azure': {
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
}
)
string
[REQUIRED]
The unique identifier of the connector to update.
string
The updated description of the connector.
dict
The updated cloud provider configuration for the connector.
Azure (dict) --
The Azure update configuration.
ScopeConfiguration (dict) -- [REQUIRED]
The updated scope configuration.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) -- [REQUIRED]
The updated list of Azure regions to monitor.
(string) --
GCP (dict) --
The GCP update configuration.
ScopeConfiguration (dict) -- [REQUIRED]
The updated scope configuration.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) -- [REQUIRED]
The updated list of GCP regions to monitor.
(string) --
A GCP region.
dict
Response Syntax
{
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}
Response Structure
(dict) --
ConnectorStatus (string) --
The connectivity status of the connector after the update.
EnablementStatus (string) --
The enablement status of the connector after the update.
{'Provider': {'GCP': {'GCPRegions': ['string'],
'ScopeConfiguration': {'ScopeType': 'PROJECT | '
'ORGANIZATION',
'ScopeValues': ['string']}}}}
Grants permission to update a connectorV2 based on its id and input parameters.
See also: AWS API Documentation
Request Syntax
client.update_connector_v2(
ConnectorId='string',
Description='string',
Provider={
'JiraCloud': {
'ProjectKey': 'string'
},
'ServiceNow': {
'SecretArn': 'string'
},
'Azure': {
'ScopeConfiguration': {
'ScopeType': 'TENANT'|'SUBSCRIPTION',
'ScopeValues': [
'string',
]
},
'AzureRegions': [
'string',
]
},
'GCP': {
'ScopeConfiguration': {
'ScopeType': 'PROJECT'|'ORGANIZATION',
'ScopeValues': [
'string',
]
},
'GCPRegions': [
'string',
]
}
}
)
string
[REQUIRED]
The UUID of the connectorV2 to identify connectorV2 resource.
string
The description of the connectorV2.
dict
The third-party provider’s service configuration.
JiraCloud (dict) --
The parameters required to update the configuration for a Jira Cloud integration.
ProjectKey (string) --
The project key for a JiraCloud instance.
ServiceNow (dict) --
The parameters required to update the configuration for a ServiceNow integration.
SecretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
Azure (dict) --
The parameters required to update the configuration for a Microsoft Azure CSPM integration.
ScopeConfiguration (dict) -- [REQUIRED]
The updated scope configuration.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are tenant and subscription.
ScopeValues (list) --
The list of scope values, such as subscription IDs, when the scope type is subscription.
(string) --
AzureRegions (list) -- [REQUIRED]
The updated list of Azure regions to monitor.
(string) --
GCP (dict) --
The parameters required to update the configuration for a Google Cloud Platform (GCP) CSPM integration.
ScopeConfiguration (dict) -- [REQUIRED]
The updated scope configuration.
ScopeType (string) -- [REQUIRED]
The type of scope. Valid values are ORGANIZATION and PROJECT.
ScopeValues (list) --
The list of scope values. Use an organization ID when the scope type is ORGANIZATION, or project IDs when the scope type is PROJECT.
(string) --
GCPRegions (list) -- [REQUIRED]
The updated list of GCP regions to monitor.
(string) --
A GCP region.
dict
Response Syntax
{
'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE'
}
Response Structure
(dict) --
ConnectorStatus (string) --
The status of the connector after the update.
EnablementStatus (string) --
The enablement status of the connector after the update.