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.ListProtections

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListProtections Source #

See: newListProtections smart constructor.

Constructors

ListProtections' 

Fields

  • inclusionFilters :: Maybe InclusionProtectionFilters

    Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter 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 ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

ToHeaders ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

ToPath ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

ToQuery ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

AWSPager ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

AWSRequest ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Associated Types

type AWSResponse ListProtections #

Generic ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Associated Types

type Rep ListProtections :: Type -> Type #

Read ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Show ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

NFData ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Methods

rnf :: ListProtections -> () #

Eq ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Hashable ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

type AWSResponse ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

type Rep ListProtections Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

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

newListProtections :: ListProtections Source #

Create a value of ListProtections 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:ListProtections', listProtections_inclusionFilters - Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

$sel:maxResults:ListProtections', listProtections_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.

ListProtections, listProtections_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

listProtections_inclusionFilters :: Lens' ListProtections (Maybe InclusionProtectionFilters) Source #

Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

listProtections_maxResults :: Lens' ListProtections (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.

listProtections_nextToken :: Lens' ListProtections (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 ListProtectionsResponse Source #

See: newListProtectionsResponse smart constructor.

Constructors

ListProtectionsResponse' 

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.

  • protections :: Maybe [Protection]

    The array of enabled Protection objects.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Associated Types

type Rep ListProtectionsResponse :: Type -> Type #

Read ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Show ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

NFData ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

Methods

rnf :: ListProtectionsResponse -> () #

Eq ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

type Rep ListProtectionsResponse Source # 
Instance details

Defined in Amazonka.Shield.ListProtections

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

newListProtectionsResponse Source #

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

ListProtections, listProtectionsResponse_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:protections:ListProtectionsResponse', listProtectionsResponse_protections - The array of enabled Protection objects.

$sel:httpStatus:ListProtectionsResponse', listProtectionsResponse_httpStatus - The response's http status code.

Response Lenses

listProtectionsResponse_nextToken :: Lens' ListProtectionsResponse (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.