ec2_report_instance_status: Report Instance Status

In aws.ecx: Communicating with AWS EC2 and ECS using AWS REST APIs

Description

Report Instance Status

Usage

ec2_report_instance_status(
  InstanceId,
  ReasonCode,
  Status,
  Description = NULL,
  DryRun = NULL,
  EndTime = NULL,
  StartTime = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

InstanceId	List. The instances.
ReasonCode	List. The reason codes that describe the health state of your instance.
Status	Character. The status of all instances listed.
Description	Character. Descriptive text about the health state of your instance.[optional]
DryRun	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
EndTime	Character. The time at which the reported instance health state ended.[optional]
StartTime	Character. The time at which the reported instance health state began.[optional]
simplify	Logical. Whether to simplify the result and handle nextToken in the response[optional]
others	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
print_on_error	Logical. Whether to show an error message when a network error occurs.
retry_time	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.
network_timeout	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
region	Character. The region of the AWS service.

Value

A list object or a character vector

InstanceId

The instances.

ReasonCode

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]

Status

The status of all instances listed.

Description

Descriptive text about the health state of your instance.

DryRun

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.

EndTime

The time at which the reported instance health state ended.

StartTime

The time at which the reported instance health state began.

aws.ecx documentation built on Jan. 27, 2022, 1:10 a.m.