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

list-labels

Description

Provides a list of labels.

See also: AWS API Documentation

Synopsis

  list-labels
--label-group-name <value>
[--interval-start-time <value>]
[--interval-end-time <value>]
[--fault-code <value>]
[--equipment <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <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

--label-group-name (string)

Returns the name of the label group.

--interval-start-time (timestamp)

Returns all the labels with a end time equal to or later than the start time given.

--interval-end-time (timestamp)

Returns all labels with a start time earlier than the end time given.

--fault-code (string)

Returns labels with a particular fault code.

--equipment (string)

Lists the labels that pertain to a particular piece of equipment.

--next-token (string)

An opaque pagination token indicating where to continue the listing of label groups.

--max-results (integer)

Specifies the maximum number of labels to list.

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

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

NextToken -> (string)

An opaque pagination token indicating where to continue the listing of datasets.

LabelSummaries -> (list)

A summary of the items in the label group.

Note

If you don't supply the LabelGroupName request parameter, or if you supply the name of a label group that doesn't exist, ListLabels returns an empty array in LabelSummaries .

(structure)

Information about the label.

LabelGroupName -> (string)

The name of the label group.

LabelId -> (string)

The ID of the label.

LabelGroupArn -> (string)

The Amazon Resource Name (ARN) of the label group.

StartTime -> (timestamp)

The timestamp indicating the start of the label.

EndTime -> (timestamp)

The timestamp indicating the end of the label.

Rating -> (string)

Indicates whether a labeled event represents an anomaly.

FaultCode -> (string)

Indicates the type of anomaly associated with the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Equipment -> (string)

Indicates that a label pertains to a particular piece of equipment.

CreatedAt -> (timestamp)

The time at which the label was created.