SecurityHub / Client / describe_action_targets

describe_action_targets#

SecurityHub.Client.describe_action_targets(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_action_targets(
    ActionTargetArns=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ActionTargetArns (list) –

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

    • (string) –

  • NextToken (string) –

    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.

  • MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'ActionTargets': [
        {
            'ActionTargetArn': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ActionTargets (list) –

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

      • (dict) –

        An ActionTarget object.

        • ActionTargetArn (string) –

          The ARN for the target action.

        • Name (string) –

          The name of the action target.

        • Description (string) –

          The description of the target action.

    • NextToken (string) –

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

Exceptions

  • SecurityHub.Client.exceptions.InternalException

  • SecurityHub.Client.exceptions.InvalidInputException

  • SecurityHub.Client.exceptions.InvalidAccessException

  • SecurityHub.Client.exceptions.ResourceNotFoundException