Amazonka.Synthetics.ListGroups

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

Creating a Request

data ListGroups

See: newListGroups smart constructor.

Constructors

ListGroups'

Fields

• maxResults :: Maybe Natural

  Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used.

• nextToken :: Maybe Text

  A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Instances

ToJSON ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

toJSON :: ListGroups -> Value

toEncoding :: ListGroups -> Encoding

toJSONList :: [ListGroups] -> Value

toEncodingList :: [ListGroups] -> Encoding

ToHeaders ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

toHeaders :: ListGroups -> [Header]

ToPath ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

toPath :: ListGroups -> ByteString

ToQuery ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

toQuery :: ListGroups -> QueryString

AWSRequest ListGroups

Defined in Amazonka.Synthetics.ListGroups

Associated Types

type AWSResponse ListGroups

Methods

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

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

Generic ListGroups

Defined in Amazonka.Synthetics.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Read ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroups

readList :: ReadS [ListGroups]

readPrec :: ReadPrec ListGroups

readListPrec :: ReadPrec [ListGroups]

Show ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

NFData ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

rnf :: ListGroups -> ()

Eq ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool

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

Hashable ListGroups

Defined in Amazonka.Synthetics.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

type AWSResponse ListGroups

Defined in Amazonka.Synthetics.ListGroups

type AWSResponse ListGroups = ListGroupsResponse

type Rep ListGroups

Defined in Amazonka.Synthetics.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.Synthetics.ListGroups" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListGroups :: ListGroups

Create a value of ListGroups 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:maxResults:ListGroups', listGroups_maxResults - Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used.

ListGroups, listGroups_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Request Lenses

listGroups_maxResults :: Lens' ListGroups (Maybe Natural)

Specify this parameter to limit how many groups are returned each time you use the ListGroups operation. If you omit this parameter, the default of 20 is used.

listGroups_nextToken :: Lens' ListGroups (Maybe Text)

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Destructuring the Response

data ListGroupsResponse

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse'

Fields

• groups :: Maybe [GroupSummary]

  An array of structures that each contain information about one group.

• nextToken :: Maybe Text

  A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

Read ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

Methods

readsPrec :: Int -> ReadS ListGroupsResponse

readList :: ReadS [ListGroupsResponse]

readPrec :: ReadPrec ListGroupsResponse

readListPrec :: ReadPrec [ListGroupsResponse]

Show ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

NFData ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

Methods

rnf :: ListGroupsResponse -> ()

Eq ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool

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

type Rep ListGroupsResponse

Defined in Amazonka.Synthetics.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.Synthetics.ListGroups" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "ListGroupsResponse'" '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))))

newListGroupsResponse

Arguments

:: Int

$sel:httpStatus:ListGroupsResponse'

-> ListGroupsResponse

Create a value of ListGroupsResponse 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:ListGroupsResponse', listGroupsResponse_groups - An array of structures that each contain information about one group.

ListGroups, listGroupsResponse_nextToken - A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupSummary])

An array of structures that each contain information about one group.

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)

A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int

The response's http status code.