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.DocDbElastic.GetCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific Elastic DocumentDB cluster.

Synopsis

data GetCluster = GetCluster' {
- clusterArn :: Text
}
newGetCluster :: Text -> GetCluster
getCluster_clusterArn :: Lens' GetCluster Text
data GetClusterResponse = GetClusterResponse' {
- httpStatus :: Int
- cluster :: Cluster
}
newGetClusterResponse :: Int -> Cluster -> GetClusterResponse
getClusterResponse_httpStatus :: Lens' GetClusterResponse Int
getClusterResponse_cluster :: Lens' GetClusterResponse Cluster

Creating a Request

data GetCluster Source #

See: newGetCluster smart constructor.

Constructors

GetCluster'
Fields clusterArn :: Text The arn of the Elastic DocumentDB cluster.

Instances

Instances details

ToHeaders GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods toHeaders :: GetCluster -> [Header] #
ToPath GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods toPath :: GetCluster -> ByteString #
ToQuery GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods toQuery :: GetCluster -> QueryString #
AWSRequest GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Associated Types type AWSResponse GetCluster # Methods request :: (Service -> Service) -> GetCluster -> Request GetCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCluster))) #
Generic GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Associated Types type Rep GetCluster :: Type -> Type # Methods from :: GetCluster -> Rep GetCluster x # to :: Rep GetCluster x -> GetCluster #
Read GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods readsPrec :: Int -> ReadS GetCluster # readList :: ReadS [GetCluster] # readPrec :: ReadPrec GetCluster # readListPrec :: ReadPrec [GetCluster] #
Show GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods showsPrec :: Int -> GetCluster -> ShowS # show :: GetCluster -> String # showList :: [GetCluster] -> ShowS #
NFData GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods rnf :: GetCluster -> () #
Eq GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods (==) :: GetCluster -> GetCluster -> Bool # (/=) :: GetCluster -> GetCluster -> Bool #
Hashable GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods hashWithSalt :: Int -> GetCluster -> Int # hash :: GetCluster -> Int #
type AWSResponse GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster type AWSResponse GetCluster = GetClusterResponse
type Rep GetCluster Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster type Rep GetCluster = D1 ('MetaData "GetCluster" "Amazonka.DocDbElastic.GetCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "GetCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetCluster Source #

Arguments

:: Text	`GetCluster`
-> GetCluster

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

GetCluster, getCluster_clusterArn - The arn of the Elastic DocumentDB cluster.

Request Lenses

getCluster_clusterArn :: Lens' GetCluster Text Source #

The arn of the Elastic DocumentDB cluster.

Destructuring the Response

data GetClusterResponse Source #

See: newGetClusterResponse smart constructor.

Constructors

GetClusterResponse'
Fields httpStatus :: Int The response's http status code. cluster :: Cluster Returns information about a specific Elastic DocumentDB cluster.

Instances

Instances details

Generic GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Associated Types type Rep GetClusterResponse :: Type -> Type # Methods from :: GetClusterResponse -> Rep GetClusterResponse x # to :: Rep GetClusterResponse x -> GetClusterResponse #
Read GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods readsPrec :: Int -> ReadS GetClusterResponse # readList :: ReadS [GetClusterResponse] # readPrec :: ReadPrec GetClusterResponse # readListPrec :: ReadPrec [GetClusterResponse] #
Show GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods showsPrec :: Int -> GetClusterResponse -> ShowS # show :: GetClusterResponse -> String # showList :: [GetClusterResponse] -> ShowS #
NFData GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods rnf :: GetClusterResponse -> () #
Eq GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster Methods (==) :: GetClusterResponse -> GetClusterResponse -> Bool # (/=) :: GetClusterResponse -> GetClusterResponse -> Bool #
type Rep GetClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.GetCluster type Rep GetClusterResponse = D1 ('MetaData "GetClusterResponse" "Amazonka.DocDbElastic.GetCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "GetClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Cluster)))

newGetClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetClusterResponse'`
-> Cluster	`$sel:cluster:GetClusterResponse'`
-> GetClusterResponse

Create a value of GetClusterResponse 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:httpStatus:GetClusterResponse', getClusterResponse_httpStatus - The response's http status code.

$sel:cluster:GetClusterResponse', getClusterResponse_cluster - Returns information about a specific Elastic DocumentDB cluster.

Response Lenses

getClusterResponse_httpStatus :: Lens' GetClusterResponse Int Source #

The response's http status code.

getClusterResponse_cluster :: Lens' GetClusterResponse Cluster Source #

Returns information about a specific Elastic DocumentDB cluster.