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

Description

Retrieves the resources that are included in the protection group.

Synopsis

Creating a Request

data ListResourcesInProtectionGroup Source #

See: newListResourcesInProtectionGroup smart constructor.

Constructors

ListResourcesInProtectionGroup' 

Fields

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

  • protectionGroupId :: Text

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Instances

Instances details
ToJSON ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

ToHeaders ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

ToPath ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

ToQuery ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

AWSRequest ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Generic ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Associated Types

type Rep ListResourcesInProtectionGroup :: Type -> Type #

Read ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Show ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

NFData ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Eq ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Hashable ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

type AWSResponse ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

type Rep ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

type Rep ListResourcesInProtectionGroup = D1 ('MetaData "ListResourcesInProtectionGroup" "Amazonka.Shield.ListResourcesInProtectionGroup" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "ListResourcesInProtectionGroup'" '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 "protectionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListResourcesInProtectionGroup Source #

Create a value of ListResourcesInProtectionGroup 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:ListResourcesInProtectionGroup', listResourcesInProtectionGroup_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.

ListResourcesInProtectionGroup, listResourcesInProtectionGroup_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.

ListResourcesInProtectionGroup, listResourcesInProtectionGroup_protectionGroupId - The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Request Lenses

listResourcesInProtectionGroup_maxResults :: Lens' ListResourcesInProtectionGroup (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.

listResourcesInProtectionGroup_nextToken :: Lens' ListResourcesInProtectionGroup (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.

listResourcesInProtectionGroup_protectionGroupId :: Lens' ListResourcesInProtectionGroup Text Source #

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Destructuring the Response

data ListResourcesInProtectionGroupResponse Source #

Constructors

ListResourcesInProtectionGroupResponse' 

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.

  • resourceArns :: [Text]

    The Amazon Resource Names (ARNs) of the resources that are included in the protection group.

Instances

Instances details
Generic ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Read ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Show ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

NFData ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Eq ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

type Rep ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

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

newListResourcesInProtectionGroupResponse Source #

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

ListResourcesInProtectionGroup, listResourcesInProtectionGroupResponse_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:ListResourcesInProtectionGroupResponse', listResourcesInProtectionGroupResponse_httpStatus - The response's http status code.

ListResourcesInProtectionGroupResponse, listResourcesInProtectionGroupResponse_resourceArns - The Amazon Resource Names (ARNs) of the resources that are included in the protection group.

Response Lenses

listResourcesInProtectionGroupResponse_nextToken :: Lens' ListResourcesInProtectionGroupResponse (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.

listResourcesInProtectionGroupResponse_resourceArns :: Lens' ListResourcesInProtectionGroupResponse [Text] Source #

The Amazon Resource Names (ARNs) of the resources that are included in the protection group.