CreateActionTarget
Creates a custom action target in Security Hub.
You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
Request Syntax
POST /actionTargets HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Id": "string",
"Name": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Description
-
The description for the custom action target.
Type: String
Pattern:
.*\S.*Required: Yes
- Id
-
The ID for the custom action target. Can contain up to 20 alphanumeric characters.
Type: String
Pattern:
.*\S.*Required: Yes
- Name
-
The name of the custom action target. Can contain up to 20 characters.
Type: String
Pattern:
.*\S.*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ActionTargetArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ActionTargetArn
-
The Amazon Resource Name (ARN) for the custom action target.
Type: String
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- LimitExceededException
-
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
- ResourceConflictException
-
The resource specified in the request conflicts with an existing resource.
HTTP Status Code: 409
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
