Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DirectoryService.DescribeRegions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the Regions that are configured for multi-Region replication.

This operation returns paginated results.

Creating a Request

data DescribeRegions Source #

See: newDescribeRegions smart constructor.

Constructors

DescribeRegions'
Fields nextToken :: Maybe Text The `DescribeRegionsResult.NextToken` value from a previous call to DescribeRegions. Pass null if this is the first call. regionName :: Maybe Text The name of the Region. For example, `us-east-1`. directoryId :: Text The identifier of the directory.

Instances

Instances details

ToJSON DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods toJSON :: DescribeRegions -> Value # toEncoding :: DescribeRegions -> Encoding # toJSONList :: [DescribeRegions] -> Value # toEncodingList :: [DescribeRegions] -> Encoding #
ToHeaders DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods toHeaders :: DescribeRegions -> [Header] #
ToPath DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods toPath :: DescribeRegions -> ByteString #
ToQuery DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods toQuery :: DescribeRegions -> QueryString #
AWSPager DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods page :: DescribeRegions -> AWSResponse DescribeRegions -> Maybe DescribeRegions #
AWSRequest DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.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.DirectoryService.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.DirectoryService.DescribeRegions Methods readsPrec :: Int -> ReadS DescribeRegions # readList :: ReadS [DescribeRegions] # readPrec :: ReadPrec DescribeRegions # readListPrec :: ReadPrec [DescribeRegions] #
Show DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods showsPrec :: Int -> DescribeRegions -> ShowS # show :: DescribeRegions -> String # showList :: [DescribeRegions] -> ShowS #
NFData DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods rnf :: DescribeRegions -> () #
Eq DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods (==) :: DescribeRegions -> DescribeRegions -> Bool # (/=) :: DescribeRegions -> DescribeRegions -> Bool #
Hashable DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods hashWithSalt :: Int -> DescribeRegions -> Int # hash :: DescribeRegions -> Int #
type AWSResponse DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions type AWSResponse DescribeRegions = DescribeRegionsResponse
type Rep DescribeRegions Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions type Rep DescribeRegions = D1 ('MetaData "DescribeRegions" "Amazonka.DirectoryService.DescribeRegions" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeRegions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeRegions Source #

Arguments

:: Text	`DescribeRegions`
-> DescribeRegions

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:

DescribeRegions, describeRegions_nextToken - The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.

DescribeRegions, describeRegions_regionName - The name of the Region. For example, us-east-1.

DescribeRegions, describeRegions_directoryId - The identifier of the directory.

Request Lenses

describeRegions_nextToken :: Lens' DescribeRegions (Maybe Text) Source #

The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.

describeRegions_regionName :: Lens' DescribeRegions (Maybe Text) Source #

The name of the Region. For example, us-east-1.

describeRegions_directoryId :: Lens' DescribeRegions Text Source #

The identifier of the directory.

Destructuring the Response

data DescribeRegionsResponse Source #

See: newDescribeRegionsResponse smart constructor.

Constructors

DescribeRegionsResponse'
Fields nextToken :: Maybe Text If not null, more results are available. Pass this value for the `NextToken` parameter in a subsequent call to DescribeRegions to retrieve the next set of items. regionsDescription :: Maybe [RegionDescription] List of Region information related to the directory for each replicated Region. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeRegionsResponse Source #
Instance details Defined in Amazonka.DirectoryService.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.DirectoryService.DescribeRegions Methods readsPrec :: Int -> ReadS DescribeRegionsResponse # readList :: ReadS [DescribeRegionsResponse] # readPrec :: ReadPrec DescribeRegionsResponse # readListPrec :: ReadPrec [DescribeRegionsResponse] #
Show DescribeRegionsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods showsPrec :: Int -> DescribeRegionsResponse -> ShowS # show :: DescribeRegionsResponse -> String # showList :: [DescribeRegionsResponse] -> ShowS #
NFData DescribeRegionsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods rnf :: DescribeRegionsResponse -> () #
Eq DescribeRegionsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions Methods (==) :: DescribeRegionsResponse -> DescribeRegionsResponse -> Bool # (/=) :: DescribeRegionsResponse -> DescribeRegionsResponse -> Bool #
type Rep DescribeRegionsResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeRegions type Rep DescribeRegionsResponse = D1 ('MetaData "DescribeRegionsResponse" "Amazonka.DirectoryService.DescribeRegions" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeRegionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "regionsDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RegionDescription])) :: 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:

DescribeRegions, describeRegionsResponse_nextToken - If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items.

$sel:regionsDescription:DescribeRegionsResponse', describeRegionsResponse_regionsDescription - List of Region information related to the directory for each replicated Region.

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

Response Lenses

describeRegionsResponse_nextToken :: Lens' DescribeRegionsResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items.

describeRegionsResponse_regionsDescription :: Lens' DescribeRegionsResponse (Maybe [RegionDescription]) Source #

List of Region information related to the directory for each replicated Region.

describeRegionsResponse_httpStatus :: Lens' DescribeRegionsResponse Int Source #

The response's http status code.