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.Synthetics.GetGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

Synopsis

data GetGroup = GetGroup' {
- groupIdentifier :: Text
}
newGetGroup :: Text -> GetGroup
getGroup_groupIdentifier :: Lens' GetGroup Text
data GetGroupResponse = GetGroupResponse' {
- group' :: Maybe Group
- httpStatus :: Int
}
newGetGroupResponse :: Int -> GetGroupResponse
getGroupResponse_group :: Lens' GetGroupResponse (Maybe Group)
getGroupResponse_httpStatus :: Lens' GetGroupResponse Int

Creating a Request

data GetGroup Source #

See: newGetGroup smart constructor.

Constructors

GetGroup'
Fields groupIdentifier :: Text Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the `GroupIdentifier`.

Instances

Instances details

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

newGetGroup Source #

Arguments

:: Text	`$sel:groupIdentifier:GetGroup'`
-> GetGroup

Create a value of GetGroup 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:groupIdentifier:GetGroup', getGroup_groupIdentifier - Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Request Lenses

getGroup_groupIdentifier :: Lens' GetGroup Text Source #

Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Destructuring the Response

data GetGroupResponse Source #

See: newGetGroupResponse smart constructor.

Constructors

GetGroupResponse'
Fields group' :: Maybe Group A structure that contains information about the group. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup Associated Types type Rep GetGroupResponse :: Type -> Type # Methods from :: GetGroupResponse -> Rep GetGroupResponse x # to :: Rep GetGroupResponse x -> GetGroupResponse #
Read GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup Methods readsPrec :: Int -> ReadS GetGroupResponse # readList :: ReadS [GetGroupResponse] # readPrec :: ReadPrec GetGroupResponse # readListPrec :: ReadPrec [GetGroupResponse] #
Show GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup Methods showsPrec :: Int -> GetGroupResponse -> ShowS # show :: GetGroupResponse -> String # showList :: [GetGroupResponse] -> ShowS #
NFData GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup Methods rnf :: GetGroupResponse -> () #
Eq GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup Methods (==) :: GetGroupResponse -> GetGroupResponse -> Bool # (/=) :: GetGroupResponse -> GetGroupResponse -> Bool #
type Rep GetGroupResponse Source #
Instance details Defined in Amazonka.Synthetics.GetGroup type Rep GetGroupResponse = D1 ('MetaData "GetGroupResponse" "Amazonka.Synthetics.GetGroup" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "GetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetGroupResponse'`
-> GetGroupResponse

Create a value of GetGroupResponse 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:group':GetGroupResponse', getGroupResponse_group - A structure that contains information about the group.

$sel:httpStatus:GetGroupResponse', getGroupResponse_httpStatus - The response's http status code.

Response Lenses

getGroupResponse_group :: Lens' GetGroupResponse (Maybe Group) Source #

A structure that contains information about the group.

getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #

The response's http status code.