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

Description

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

Synopsis

Creating a Request

data DescribeRegions Source #

See: newDescribeRegions smart constructor.

Constructors

DescribeRegions' 

Fields

  • allRegions :: Maybe Bool

    Indicates whether to display all Regions, including Regions that are disabled for your account.

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

  • filters :: Maybe [Filter]

    The filters.

    • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
    • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
    • region-name - The name of the Region (for example, us-east-1).
  • regionNames :: Maybe [Text]

    The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Instances

Instances details
ToHeaders DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

toHeaders :: DescribeRegions -> [Header] #

ToPath DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

toPath :: DescribeRegions -> ByteString #

ToQuery DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

toQuery :: DescribeRegions -> QueryString #

AWSRequest DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Associated Types

type AWSResponse DescribeRegions #

Methods

request :: (Service -> Service) -> DescribeRegions -> Request DescribeRegions #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRegions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRegions))) #

Generic DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Associated Types

type Rep DescribeRegions :: Type -> Type #

Methods

from :: DescribeRegions -> Rep DescribeRegions x #

to :: Rep DescribeRegions x -> DescribeRegions #

Read DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

readsPrec :: Int -> ReadS DescribeRegions #

readList :: ReadS [DescribeRegions] #

readPrec :: ReadPrec DescribeRegions #

readListPrec :: ReadPrec [DescribeRegions] #

Show DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

showsPrec :: Int -> DescribeRegions -> ShowS #

show :: DescribeRegions -> String #

showList :: [DescribeRegions] -> ShowS #

NFData DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

rnf :: DescribeRegions -> () #

Eq DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

(==) :: DescribeRegions -> DescribeRegions -> Bool #

(/=) :: DescribeRegions -> DescribeRegions -> Bool #

Hashable DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

hashWithSalt :: Int -> DescribeRegions -> Int #

hash :: DescribeRegions -> Int #

type AWSResponse DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

type AWSResponse DescribeRegions = DescribeRegionsResponse
type Rep DescribeRegions Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

type Rep DescribeRegions = D1 ('MetaData "DescribeRegions" "Amazonka.EC2.DescribeRegions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeRegions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "regionNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeRegions :: DescribeRegions Source #

Create a value of DescribeRegions 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:allRegions:DescribeRegions', describeRegions_allRegions - Indicates whether to display all Regions, including Regions that are disabled for your account.

$sel:dryRun:DescribeRegions', describeRegions_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.

$sel:filters:DescribeRegions', describeRegions_filters - The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
  • region-name - The name of the Region (for example, us-east-1).

$sel:regionNames:DescribeRegions', describeRegions_regionNames - The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Request Lenses

describeRegions_allRegions :: Lens' DescribeRegions (Maybe Bool) Source #

Indicates whether to display all Regions, including Regions that are disabled for your account.

describeRegions_dryRun :: Lens' DescribeRegions (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.

describeRegions_filters :: Lens' DescribeRegions (Maybe [Filter]) Source #

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
  • region-name - The name of the Region (for example, us-east-1).

describeRegions_regionNames :: Lens' DescribeRegions (Maybe [Text]) Source #

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Destructuring the Response

data DescribeRegionsResponse Source #

See: newDescribeRegionsResponse smart constructor.

Constructors

DescribeRegionsResponse' 

Fields

Instances

Instances details
Generic DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Associated Types

type Rep DescribeRegionsResponse :: Type -> Type #

Methods

from :: DescribeRegionsResponse -> Rep DescribeRegionsResponse x #

to :: Rep DescribeRegionsResponse x -> DescribeRegionsResponse #

Read DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

readsPrec :: Int -> ReadS DescribeRegionsResponse #

readList :: ReadS [DescribeRegionsResponse] #

readPrec :: ReadPrec DescribeRegionsResponse #

readListPrec :: ReadPrec [DescribeRegionsResponse] #

Show DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

showsPrec :: Int -> DescribeRegionsResponse -> ShowS #

show :: DescribeRegionsResponse -> String #

showList :: [DescribeRegionsResponse] -> ShowS #

NFData DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

rnf :: DescribeRegionsResponse -> () #

Eq DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

Methods

(==) :: DescribeRegionsResponse -> DescribeRegionsResponse -> Bool #

(/=) :: DescribeRegionsResponse -> DescribeRegionsResponse -> Bool #

type Rep DescribeRegionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeRegions

type Rep DescribeRegionsResponse = D1 ('MetaData "DescribeRegionsResponse" "Amazonka.EC2.DescribeRegions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeRegionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RegionInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeRegionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeRegionsResponse'

-> DescribeRegionsResponse 

Create a value of DescribeRegionsResponse 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:regions:DescribeRegionsResponse', describeRegionsResponse_regions - Information about the Regions.

$sel:httpStatus:DescribeRegionsResponse', describeRegionsResponse_httpStatus - The response's http status code.

Response Lenses

describeRegionsResponse_regions :: Lens' DescribeRegionsResponse (Maybe [RegionInfo]) Source #

Information about the Regions.

describeRegionsResponse_httpStatus :: Lens' DescribeRegionsResponse Int Source #

The response's http status code.