Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityhub ]

describe-action-targets

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-action-targets
[--action-target-arns <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--action-target-arns (list)

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

(string)

Syntax:

"string" "string" ...

--next-token (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.

--max-results (integer)

The maximum number of results to return.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve details about custom actions

The following describe-action-targets example retrieves information about the custom action identified by the specified ARN.

aws securityhub describe-action-targets \
    --action-target-arns "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"

Output:

{
    "ActionTargets": [
        {
            "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation",
            "Description": "Action to send the finding for remediation tracking",
            "Name": "Send to remediation"
        }
    ]
}

For more information, see Creating a custom action and associating it with a CloudWatch Events rule in the AWS Security Hub User Guide.

Output

ActionTargets -> (list)

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

(structure)

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.