amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ReportInstanceStatus

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.

Synopsis

Creating a Request

data ReportInstanceStatus Source #

See: newReportInstanceStatus smart constructor.

Constructors

ReportInstanceStatus' 

Fields

  • description :: Maybe Text

    Descriptive text about the health state of your instance.

  • dryRun :: Maybe Bool

    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 :: Maybe ISO8601

    The time at which the reported instance health state ended.

  • startTime :: Maybe ISO8601

    The time at which the reported instance health state began.

  • instances :: [Text]

    The instances.

  • reasonCodes :: [ReportInstanceReasonCodes]

    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 :: ReportStatusType

    The status of all instances listed.

Instances

Instances details
ToHeaders ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

ToPath ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

ToQuery ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

AWSRequest ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Associated Types

type AWSResponse ReportInstanceStatus #

Generic ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Associated Types

type Rep ReportInstanceStatus :: Type -> Type #

Read ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Show ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

NFData ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Methods

rnf :: ReportInstanceStatus -> () #

Eq ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Hashable ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

type AWSResponse ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

type Rep ReportInstanceStatus Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

newReportInstanceStatus Source #

Create a value of ReportInstanceStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ReportInstanceStatus, reportInstanceStatus_description - Descriptive text about the health state of your instance.

$sel:dryRun:ReportInstanceStatus', reportInstanceStatus_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.

ReportInstanceStatus, reportInstanceStatus_endTime - The time at which the reported instance health state ended.

ReportInstanceStatus, reportInstanceStatus_startTime - The time at which the reported instance health state began.

ReportInstanceStatus, reportInstanceStatus_instances - The instances.

$sel:reasonCodes:ReportInstanceStatus', reportInstanceStatus_reasonCodes - 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]

ReportInstanceStatus, reportInstanceStatus_status - The status of all instances listed.

Request Lenses

reportInstanceStatus_description :: Lens' ReportInstanceStatus (Maybe Text) Source #

Descriptive text about the health state of your instance.

reportInstanceStatus_dryRun :: Lens' ReportInstanceStatus (Maybe Bool) Source #

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.

reportInstanceStatus_endTime :: Lens' ReportInstanceStatus (Maybe UTCTime) Source #

The time at which the reported instance health state ended.

reportInstanceStatus_startTime :: Lens' ReportInstanceStatus (Maybe UTCTime) Source #

The time at which the reported instance health state began.

reportInstanceStatus_reasonCodes :: Lens' ReportInstanceStatus [ReportInstanceReasonCodes] Source #

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]

Destructuring the Response

data ReportInstanceStatusResponse Source #

See: newReportInstanceStatusResponse smart constructor.

Instances

Instances details
Generic ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Associated Types

type Rep ReportInstanceStatusResponse :: Type -> Type #

Read ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Show ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

NFData ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

Eq ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

type Rep ReportInstanceStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.ReportInstanceStatus

type Rep ReportInstanceStatusResponse = D1 ('MetaData "ReportInstanceStatusResponse" "Amazonka.EC2.ReportInstanceStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ReportInstanceStatusResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newReportInstanceStatusResponse :: ReportInstanceStatusResponse Source #

Create a value of ReportInstanceStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.