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

report-instance-status

Description

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus , use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus .

See also: AWS API Documentation

Synopsis

  report-instance-status
[--description <value>]
[--dry-run | --no-dry-run]
[--end-time <value>]
--instances <value>
--reason-codes <value>
[--start-time <value>]
--status <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

--description (string)

Descriptive text about the health state of your instance.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--end-time (timestamp)

The time at which the reported instance health state ended.

--instances (list)

The instances.

(string)

Syntax:

"string" "string" ...

--reason-codes (list)

The reason codes that describe the health state of your instance.

  • instance-stuck-in-state : My instance is stuck in a state.
  • unresponsive : My instance is unresponsive.
  • not-accepting-credentials : My instance is not accepting my credentials.
  • password-not-available : A password is not available for my instance.
  • performance-network : My instance is experiencing performance problems that I believe are network related.
  • performance-instance-store : My instance is experiencing performance problems that I believe are related to the instance stores.
  • performance-ebs-volume : My instance is experiencing performance problems that I believe are related to an EBS volume.
  • performance-other : My instance is experiencing performance problems.
  • other : [explain using the description parameter]

(string)

Syntax:

"string" "string" ...

Where valid values are:
  instance-stuck-in-state
  unresponsive
  not-accepting-credentials
  password-not-available
  performance-network
  performance-instance-store
  performance-ebs-volume
  performance-other
  other

--start-time (timestamp)

The time at which the reported instance health state began.

--status (string)

The status of all instances listed.

Possible values:

  • ok
  • impaired

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

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To report status feedback for an instance

This example command reports status feedback for the specified instance.

Command:

aws ec2 report-instance-status --instances i-1234567890abcdef0 --status impaired --reason-codes unresponsive

Output

None