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

Description

Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data GetSerialConsoleAccessStatus Source #

See: newGetSerialConsoleAccessStatus smart constructor.

Constructors

GetSerialConsoleAccessStatus' 

Fields

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

Instances

Instances details
ToHeaders GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

ToPath GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

ToQuery GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

AWSRequest GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Generic GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Associated Types

type Rep GetSerialConsoleAccessStatus :: Type -> Type #

Read GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Show GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

NFData GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Eq GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Hashable GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

type AWSResponse GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

type Rep GetSerialConsoleAccessStatus Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

type Rep GetSerialConsoleAccessStatus = D1 ('MetaData "GetSerialConsoleAccessStatus" "Amazonka.EC2.GetSerialConsoleAccessStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetSerialConsoleAccessStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newGetSerialConsoleAccessStatus :: GetSerialConsoleAccessStatus Source #

Create a value of GetSerialConsoleAccessStatus 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:

$sel:dryRun:GetSerialConsoleAccessStatus', getSerialConsoleAccessStatus_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.

Request Lenses

getSerialConsoleAccessStatus_dryRun :: Lens' GetSerialConsoleAccessStatus (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.

Destructuring the Response

data GetSerialConsoleAccessStatusResponse Source #

Constructors

GetSerialConsoleAccessStatusResponse' 

Fields

  • serialConsoleAccessEnabled :: Maybe Bool

    If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Read GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Show GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

NFData GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

Eq GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

type Rep GetSerialConsoleAccessStatusResponse Source # 
Instance details

Defined in Amazonka.EC2.GetSerialConsoleAccessStatus

type Rep GetSerialConsoleAccessStatusResponse = D1 ('MetaData "GetSerialConsoleAccessStatusResponse" "Amazonka.EC2.GetSerialConsoleAccessStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetSerialConsoleAccessStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serialConsoleAccessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetSerialConsoleAccessStatusResponse Source #

Create a value of GetSerialConsoleAccessStatusResponse 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:

$sel:serialConsoleAccessEnabled:GetSerialConsoleAccessStatusResponse', getSerialConsoleAccessStatusResponse_serialConsoleAccessEnabled - If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.

$sel:httpStatus:GetSerialConsoleAccessStatusResponse', getSerialConsoleAccessStatusResponse_httpStatus - The response's http status code.

Response Lenses

getSerialConsoleAccessStatusResponse_serialConsoleAccessEnabled :: Lens' GetSerialConsoleAccessStatusResponse (Maybe Bool) Source #

If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.