Amazonka.XRay.GetGroups

Retrieves all active group details.

This operation returns paginated results.

Creating a Request

data GetGroups

See: newGetGroups smart constructor.

Constructors

GetGroups'

Fields

• nextToken :: Maybe Text

  Pagination token.

Instances

ToJSON GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

toJSON :: GetGroups -> Value

toEncoding :: GetGroups -> Encoding

toJSONList :: [GetGroups] -> Value

toEncodingList :: [GetGroups] -> Encoding

ToHeaders GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

toHeaders :: GetGroups -> [Header]

ToPath GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

toPath :: GetGroups -> ByteString

ToQuery GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

toQuery :: GetGroups -> QueryString

AWSPager GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

page :: GetGroups -> AWSResponse GetGroups -> Maybe GetGroups

AWSRequest GetGroups

Defined in Amazonka.XRay.GetGroups

Associated Types

type AWSResponse GetGroups

Methods

request :: (Service -> Service) -> GetGroups -> Request GetGroups

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

Generic GetGroups

Defined in Amazonka.XRay.GetGroups

Associated Types

type Rep GetGroups :: Type -> Type

Methods

from :: GetGroups -> Rep GetGroups x

to :: Rep GetGroups x -> GetGroups

Read GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

readsPrec :: Int -> ReadS GetGroups

readList :: ReadS [GetGroups]

readPrec :: ReadPrec GetGroups

readListPrec :: ReadPrec [GetGroups]

Show GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

showsPrec :: Int -> GetGroups -> ShowS

show :: GetGroups -> String

showList :: [GetGroups] -> ShowS

NFData GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

rnf :: GetGroups -> ()

Eq GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

(==) :: GetGroups -> GetGroups -> Bool

(/=) :: GetGroups -> GetGroups -> Bool

Hashable GetGroups

Defined in Amazonka.XRay.GetGroups

Methods

hashWithSalt :: Int -> GetGroups -> Int

hash :: GetGroups -> Int

type AWSResponse GetGroups

Defined in Amazonka.XRay.GetGroups

type AWSResponse GetGroups = GetGroupsResponse

type Rep GetGroups

Defined in Amazonka.XRay.GetGroups

type Rep GetGroups = D1 ('MetaData "GetGroups" "Amazonka.XRay.GetGroups" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetGroups :: GetGroups

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

GetGroups, getGroups_nextToken - Pagination token.

Request Lenses

getGroups_nextToken :: Lens' GetGroups (Maybe Text)

Pagination token.

Destructuring the Response

data GetGroupsResponse

See: newGetGroupsResponse smart constructor.

Constructors

GetGroupsResponse'

Fields

• groups :: Maybe [GroupSummary]

  The collection of all active groups.

• nextToken :: Maybe Text

  Pagination token.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

Associated Types

type Rep GetGroupsResponse :: Type -> Type

Methods

from :: GetGroupsResponse -> Rep GetGroupsResponse x

to :: Rep GetGroupsResponse x -> GetGroupsResponse

Read GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

Methods

readsPrec :: Int -> ReadS GetGroupsResponse

readList :: ReadS [GetGroupsResponse]

readPrec :: ReadPrec GetGroupsResponse

readListPrec :: ReadPrec [GetGroupsResponse]

Show GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

Methods

showsPrec :: Int -> GetGroupsResponse -> ShowS

show :: GetGroupsResponse -> String

showList :: [GetGroupsResponse] -> ShowS

NFData GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

Methods

rnf :: GetGroupsResponse -> ()

Eq GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

Methods

(==) :: GetGroupsResponse -> GetGroupsResponse -> Bool

(/=) :: GetGroupsResponse -> GetGroupsResponse -> Bool

type Rep GetGroupsResponse

Defined in Amazonka.XRay.GetGroups

type Rep GetGroupsResponse = D1 ('MetaData "GetGroupsResponse" "Amazonka.XRay.GetGroups" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "GetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetGroupsResponse

Arguments

:: Int

GetGroupsResponse

-> GetGroupsResponse

Create a value of GetGroupsResponse 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:groups:GetGroupsResponse', getGroupsResponse_groups - The collection of all active groups.

GetGroups, getGroupsResponse_nextToken - Pagination token.

GetGroupsResponse, getGroupsResponse_httpStatus - The response's http status code.

Response Lenses

getGroupsResponse_groups :: Lens' GetGroupsResponse (Maybe [GroupSummary])

The collection of all active groups.

getGroupsResponse_nextToken :: Lens' GetGroupsResponse (Maybe Text)

Pagination token.

getGroupsResponse_httpStatus :: Lens' GetGroupsResponse Int

The response's http status code.