Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeActionTargets

Returns a list of the custom action targets in Security Hub in your account.

Request Syntax


POST /actionTargets/get HTTP/1.1
Content-type: application/json

{
   "ActionTargetArns": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ActionTargetArns

A list of custom action target ARNs for the custom action targets to retrieve.

Type: Array of strings

Pattern: .*\S.*

Required: No

MaxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token that is required for pagination. On your first call to the DescribeActionTargets 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.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ActionTargets": [ 
      { 
         "ActionTargetArn": "string",
         "Description": "string",
         "Name": "string"
      }
   ],
   "NextToken": "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.

ActionTargets

A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.

Type: Array of ActionTarget objects

NextToken

The pagination token to use to request the next page of results.

Type: String

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

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404