AWS Security Hub · Schema
BatchGetSecurityControlsResponse
SecurityCloud Security Posture ManagementComplianceFindingsThreat DetectionCloudAmazon Web Services
Properties
| Name | Type | Description |
|---|---|---|
| SecurityControls | array | 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 Securit |
| UnprocessedIds | array | A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/aws-security-hub/json-schema/aws-security-hub-batch-get-security-controls-response-schema.json",
"title": "BatchGetSecurityControlsResponse",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/aws-security-hub-controls-api-openapi.yml#/components/schemas/BatchGetSecurityControlsResponse",
"type": "object",
"properties": {
"SecurityControls": {
"type": "array",
"items": {
"$ref": "#/$defs/SecurityControl"
},
"description": "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."
},
"UnprocessedIds": {
"type": "array",
"items": {
"$ref": "#/$defs/UnprocessedSecurityControl"
},
"description": "A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned."
}
},
"required": [
"SecurityControls"
],
"$defs": {
"ParameterConfiguration": {
"type": "object",
"properties": {
"ValueType": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "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": {
"$ref": "#/$defs/ParameterValue"
}
},
"required": [
"ValueType"
]
},
"ParameterValue": {
"type": "object",
"properties": {
"Integer": {
"type": "integer",
"description": "A control parameter that is an integer."
},
"IntegerList": {
"type": "array",
"items": {
"type": "integer"
},
"description": "A control parameter that is a list of integers."
},
"Double": {
"type": "number",
"description": "A control parameter that is a double."
},
"String": {
"type": "string",
"description": "A control parameter that is a string."
},
"StringList": {
"type": "array",
"items": {
"type": "string"
},
"description": "A control parameter that is a list of strings."
},
"Boolean": {
"type": "boolean",
"description": "A control parameter that is a boolean."
},
"Enum": {
"type": "string",
"description": "A control parameter that is an enum."
},
"EnumList": {
"type": "array",
"items": {
"type": "string"
},
"description": "A control parameter that is a list of enums."
}
},
"description": "Exactly one member is set."
},
"SecurityControl": {
"type": "object",
"properties": {
"SecurityControlId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The title of a security control."
},
"Description": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A link to Security Hub CSPM documentation that explains how to remediate a failed finding for a security control."
},
"SeverityRating": {
"type": "string",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"description": "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": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
],
"description": "The enablement status of a security control in a specific standard."
},
"UpdateStatus": {
"type": "string",
"enum": [
"READY",
"UPDATING"
],
"description": "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": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/ParameterConfiguration"
},
"description": "An object that identifies the name of a control parameter, its current value, and whether it has been customized."
},
"LastUpdateReason": {
"type": "string",
"description": "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": {
"type": "string",
"enum": [
"AWS",
"Azure"
],
"description": "The cloud provider whose resources the security control evaluates. For example, AWS or Azure."
}
},
"required": [
"SecurityControlId",
"SecurityControlArn",
"Title",
"Description",
"RemediationUrl",
"SeverityRating",
"SecurityControlStatus"
]
},
"UnprocessedSecurityControl": {
"type": "object",
"properties": {
"SecurityControlId": {
"type": "string",
"description": "The control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which a response couldn't be returned."
},
"ErrorCode": {
"type": "string",
"enum": [
"INVALID_INPUT",
"ACCESS_DENIED",
"NOT_FOUND",
"RESOURCE_NOT_FOUND",
"LIMIT_EXCEEDED"
],
"description": "The error code for the unprocessed security control. The NOT_FOUND value has been deprecated and replaced by the RESOURCE_NOT_FOUND value."
},
"ErrorReason": {
"type": "string",
"description": "The reason why the security control was unprocessed."
}
},
"required": [
"SecurityControlId",
"ErrorCode"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aws-security-hub-batch-get-security-controls-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.