amazonka-shield-2.0: Amazon Shield 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.Shield.ListProtectionGroups

Description

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.

Synopsis

Creating a Request

data ListProtectionGroups Source #

See: newListProtectionGroups smart constructor.

Constructors

ListProtectionGroups' 

Fields

  • inclusionFilters :: Maybe InclusionProtectionGroupFilters

    Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

  • maxResults :: Maybe Natural

    The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

    The default setting is 20.

  • nextToken :: Maybe Text

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

    On your first call to a list operation, leave this setting empty.

Instances

Instances details
ToJSON ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

ToHeaders ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

ToPath ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

ToQuery ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

AWSRequest ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Associated Types

type AWSResponse ListProtectionGroups #

Generic ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Associated Types

type Rep ListProtectionGroups :: Type -> Type #

Read ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Show ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

NFData ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Methods

rnf :: ListProtectionGroups -> () #

Eq ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Hashable ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

type AWSResponse ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

type Rep ListProtectionGroups Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

type Rep ListProtectionGroups = D1 ('MetaData "ListProtectionGroups" "Amazonka.Shield.ListProtectionGroups" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "ListProtectionGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inclusionFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InclusionProtectionGroupFilters)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListProtectionGroups :: ListProtectionGroups Source #

Create a value of ListProtectionGroups 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:inclusionFilters:ListProtectionGroups', listProtectionGroups_inclusionFilters - Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

$sel:maxResults:ListProtectionGroups', listProtectionGroups_maxResults - The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

ListProtectionGroups, listProtectionGroups_nextToken - When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

Request Lenses

listProtectionGroups_inclusionFilters :: Lens' ListProtectionGroups (Maybe InclusionProtectionGroupFilters) Source #

Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

listProtectionGroups_maxResults :: Lens' ListProtectionGroups (Maybe Natural) Source #

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.

The default setting is 20.

listProtectionGroups_nextToken :: Lens' ListProtectionGroups (Maybe Text) Source #

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

Destructuring the Response

data ListProtectionGroupsResponse Source #

See: newListProtectionGroupsResponse smart constructor.

Constructors

ListProtectionGroupsResponse' 

Fields

  • nextToken :: Maybe Text

    When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

    You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

    Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

  • httpStatus :: Int

    The response's http status code.

  • protectionGroups :: [ProtectionGroup]
     

Instances

Instances details
Generic ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Associated Types

type Rep ListProtectionGroupsResponse :: Type -> Type #

Read ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Show ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

NFData ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

Eq ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

type Rep ListProtectionGroupsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtectionGroups

type Rep ListProtectionGroupsResponse = D1 ('MetaData "ListProtectionGroupsResponse" "Amazonka.Shield.ListProtectionGroups" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "ListProtectionGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "protectionGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ProtectionGroup]))))

newListProtectionGroupsResponse Source #

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

ListProtectionGroups, listProtectionGroupsResponse_nextToken - When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

$sel:httpStatus:ListProtectionGroupsResponse', listProtectionGroupsResponse_httpStatus - The response's http status code.

$sel:protectionGroups:ListProtectionGroupsResponse', listProtectionGroupsResponse_protectionGroups -

Response Lenses

listProtectionGroupsResponse_nextToken :: Lens' ListProtectionGroupsResponse (Maybe Text) Source #

When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.