amazonka-synthetics-2.0: Amazon Synthetics SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Synthetics.ListGroupResources

Description

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

Synopsis

Creating a Request

data ListGroupResources Source #

See: newListGroupResources smart constructor.

Constructors

ListGroupResources' 

Fields

  • maxResults :: Maybe Natural

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

  • 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
ToJSON ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

ToHeaders ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

ToPath ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

ToQuery ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

AWSRequest ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Associated Types

type AWSResponse ListGroupResources #

Generic ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Associated Types

type Rep ListGroupResources :: Type -> Type #

Read ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Show ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

NFData ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Methods

rnf :: ListGroupResources -> () #

Eq ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Hashable ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

type AWSResponse ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

type Rep ListGroupResources Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

type Rep ListGroupResources = D1 ('MetaData "ListGroupResources" "Amazonka.Synthetics.ListGroupResources" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "ListGroupResources'" '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 "groupIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListGroupResources Source #

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

ListGroupResources, listGroupResources_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:groupIdentifier:ListGroupResources', listGroupResources_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

listGroupResources_maxResults :: Lens' ListGroupResources (Maybe Natural) Source #

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

listGroupResources_nextToken :: Lens' ListGroupResources (Maybe Text) Source #

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.

listGroupResources_groupIdentifier :: Lens' ListGroupResources 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 ListGroupResourcesResponse Source #

See: newListGroupResourcesResponse smart constructor.

Constructors

ListGroupResourcesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • resources :: Maybe [Text]

    An array of ARNs. These ARNs are for the canaries that are associated with the group.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Associated Types

type Rep ListGroupResourcesResponse :: Type -> Type #

Read ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Show ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

NFData ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

Eq ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

type Rep ListGroupResourcesResponse Source # 
Instance details

Defined in Amazonka.Synthetics.ListGroupResources

type Rep ListGroupResourcesResponse = D1 ('MetaData "ListGroupResourcesResponse" "Amazonka.Synthetics.ListGroupResources" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "ListGroupResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupResourcesResponse Source #

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

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

$sel:resources:ListGroupResourcesResponse', listGroupResourcesResponse_resources - An array of ARNs. These ARNs are for the canaries that are associated with the group.

$sel:httpStatus:ListGroupResourcesResponse', listGroupResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listGroupResourcesResponse_nextToken :: Lens' ListGroupResourcesResponse (Maybe Text) Source #

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

listGroupResourcesResponse_resources :: Lens' ListGroupResourcesResponse (Maybe [Text]) Source #

An array of ARNs. These ARNs are for the canaries that are associated with the group.