AWS CLI Command Reference

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 . medialive ]

list-cloud-watch-alarm-templates

Description

Lists cloudwatch alarm templates.

See also: AWS API Documentation

list-cloud-watch-alarm-templates is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: CloudWatchAlarmTemplates

Synopsis

  list-cloud-watch-alarm-templates
[--group-identifier <value>]
[--scope <value>]
[--signal-map-identifier <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--group-identifier (string) A cloudwatch alarm template group's identifier. Can be either be its id or current name.

--scope (string) Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.

--signal-map-identifier (string) A signal map's identifier. Can be either be its id or current name.

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

CloudWatchAlarmTemplates -> (list)

Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary

(structure)

Placeholder documentation for CloudWatchAlarmTemplateSummary

Arn -> (string)

A cloudwatch alarm template's ARN (Amazon Resource Name)

ComparisonOperator -> (string)

The comparison operator used to compare the specified statistic and the threshold.

CreatedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

DatapointsToAlarm -> (integer)

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

Description -> (string)

A resource's optional description.

EvaluationPeriods -> (integer)

The number of periods over which data is compared to the specified threshold.

GroupId -> (string)

A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-

Id -> (string)

A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-

MetricName -> (string)

The name of the metric associated with the alarm. Must be compatible with targetResourceType.

ModifiedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

Name -> (string)

A resource's name. Names must be unique within the scope of a resource type in a specific region.

Period -> (integer)

The period, in seconds, over which the specified statistic is applied.

Statistic -> (string)

The statistic to apply to the alarm's metric data.

Tags -> (map)

Represents the tags associated with a resource.

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string

TargetResourceType -> (string)

The resource type this template should dynamically generate cloudwatch metric alarms for.

Threshold -> (double)

The threshold value to compare with the specified statistic.

TreatMissingData -> (string)

Specifies how missing data points are treated when evaluating the alarm's condition.

NextToken -> (string)

A token used to retrieve the next set of results in paginated list responses.