Amazonka.Synthetics.ListAssociatedGroups

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

Creating a Request

data ListAssociatedGroups

See: newListAssociatedGroups smart constructor.

Constructors

ListAssociatedGroups'

Fields

• maxResults :: Maybe Natural

  Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups 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.

• resourceArn :: Text

  The ARN of the canary that you want to view groups for.

Instances

ToJSON ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

toJSON :: ListAssociatedGroups -> Value

toEncoding :: ListAssociatedGroups -> Encoding

toJSONList :: [ListAssociatedGroups] -> Value

toEncodingList :: [ListAssociatedGroups] -> Encoding

ToHeaders ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

toHeaders :: ListAssociatedGroups -> [Header]

ToPath ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

toPath :: ListAssociatedGroups -> ByteString

ToQuery ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

toQuery :: ListAssociatedGroups -> QueryString

AWSRequest ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Associated Types

type AWSResponse ListAssociatedGroups

Methods

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

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

Generic ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Associated Types

type Rep ListAssociatedGroups :: Type -> Type

Methods

from :: ListAssociatedGroups -> Rep ListAssociatedGroups x

to :: Rep ListAssociatedGroups x -> ListAssociatedGroups

Read ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

readsPrec :: Int -> ReadS ListAssociatedGroups

readList :: ReadS [ListAssociatedGroups]

readPrec :: ReadPrec ListAssociatedGroups

readListPrec :: ReadPrec [ListAssociatedGroups]

Show ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

showsPrec :: Int -> ListAssociatedGroups -> ShowS

show :: ListAssociatedGroups -> String

showList :: [ListAssociatedGroups] -> ShowS

NFData ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

rnf :: ListAssociatedGroups -> ()

Eq ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

(==) :: ListAssociatedGroups -> ListAssociatedGroups -> Bool

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

Hashable ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

hashWithSalt :: Int -> ListAssociatedGroups -> Int

hash :: ListAssociatedGroups -> Int

type AWSResponse ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

type AWSResponse ListAssociatedGroups = ListAssociatedGroupsResponse

type Rep ListAssociatedGroups

Defined in Amazonka.Synthetics.ListAssociatedGroups

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

newListAssociatedGroups

Arguments

:: Text

$sel:resourceArn:ListAssociatedGroups'

-> ListAssociatedGroups

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

ListAssociatedGroups, listAssociatedGroups_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.

$sel:resourceArn:ListAssociatedGroups', listAssociatedGroups_resourceArn - The ARN of the canary that you want to view groups for.

Request Lenses

listAssociatedGroups_maxResults :: Lens' ListAssociatedGroups (Maybe Natural)

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

listAssociatedGroups_nextToken :: Lens' ListAssociatedGroups (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.

listAssociatedGroups_resourceArn :: Lens' ListAssociatedGroups Text

The ARN of the canary that you want to view groups for.

Destructuring the Response

data ListAssociatedGroupsResponse

See: newListAssociatedGroupsResponse smart constructor.

Constructors

ListAssociatedGroupsResponse'

Fields

• groups :: Maybe [GroupSummary]

  An array of structures that contain information about the groups that this canary is associated with.

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

Associated Types

type Rep ListAssociatedGroupsResponse :: Type -> Type

Methods

from :: ListAssociatedGroupsResponse -> Rep ListAssociatedGroupsResponse x

to :: Rep ListAssociatedGroupsResponse x -> ListAssociatedGroupsResponse

Read ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

readsPrec :: Int -> ReadS ListAssociatedGroupsResponse

readList :: ReadS [ListAssociatedGroupsResponse]

readPrec :: ReadPrec ListAssociatedGroupsResponse

readListPrec :: ReadPrec [ListAssociatedGroupsResponse]

Show ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

showsPrec :: Int -> ListAssociatedGroupsResponse -> ShowS

show :: ListAssociatedGroupsResponse -> String

showList :: [ListAssociatedGroupsResponse] -> ShowS

NFData ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

rnf :: ListAssociatedGroupsResponse -> ()

Eq ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

Methods

(==) :: ListAssociatedGroupsResponse -> ListAssociatedGroupsResponse -> Bool

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

type Rep ListAssociatedGroupsResponse

Defined in Amazonka.Synthetics.ListAssociatedGroups

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

newListAssociatedGroupsResponse

Arguments

:: Int

$sel:httpStatus:ListAssociatedGroupsResponse'

-> ListAssociatedGroupsResponse

Create a value of ListAssociatedGroupsResponse 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:ListAssociatedGroupsResponse', listAssociatedGroupsResponse_groups - An array of structures that contain information about the groups that this canary is associated with.

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

$sel:httpStatus:ListAssociatedGroupsResponse', listAssociatedGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listAssociatedGroupsResponse_groups :: Lens' ListAssociatedGroupsResponse (Maybe [GroupSummary])

An array of structures that contain information about the groups that this canary is associated with.

listAssociatedGroupsResponse_nextToken :: Lens' ListAssociatedGroupsResponse (Maybe Text)

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

listAssociatedGroupsResponse_httpStatus :: Lens' ListAssociatedGroupsResponse Int

The response's http status code.