Skip to content

report_instance_status

Operation

report_instance_status

report_instance_status(request: ReportInstanceStatusInput | ReportInstanceStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReportInstanceStatusInputDict]) -> ReportInstanceStatusOutput

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.

Parameters:

Name Type Description Default
request ReportInstanceStatusInput | ReportInstanceStatusInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ReportInstanceStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ReportInstanceStatusOutput

An instance of ReportInstanceStatusOutput.

report_instance_status async

report_instance_status(request: ReportInstanceStatusInput | ReportInstanceStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReportInstanceStatusInputDict]) -> ReportInstanceStatusOutput

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.

Parameters:

Name Type Description Default
request ReportInstanceStatusInput | ReportInstanceStatusInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ReportInstanceStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ReportInstanceStatusOutput

An instance of ReportInstanceStatusOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ReportInstanceStatusInputDict

Bases: TypedDict

Dictionary form of ReportInstanceStatusInput.

Attributes

description instance-attribute
description: str | None

Descriptive text about the health state of your instance.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the operation, 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 instance-attribute
end_time: datetime | None

The time at which the reported instance health state ended.

instances instance-attribute
instances: Required[Sequence[str]]

The instances.

reason_codes instance-attribute
reason_codes: Required[Sequence[str]]

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]

start_time instance-attribute
start_time: datetime | None

The time at which the reported instance health state began.

status instance-attribute
status: Required[str]

The status of all instances listed.

ReportInstanceStatusInput dataclass

Bases: _SerdeShape

Dataclass for ReportInstanceStatusInput structure.

Attributes

description class-attribute instance-attribute
description: str | None = ...

Descriptive text about the health state of your instance.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the operation, 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 class-attribute instance-attribute
end_time: datetime | None = ...

The time at which the reported instance health state ended.

instances class-attribute instance-attribute
instances: list[str] | None = ...

The instances.

reason_codes class-attribute instance-attribute
reason_codes: list[str] | None = ...

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]

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The time at which the reported instance health state began.

status class-attribute instance-attribute
status: str | None = ...

The status of all instances listed.

Output

ReportInstanceStatusOutput dataclass

Bases: _SerdeShape

Dataclass for ReportInstanceStatusOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.