libZSservicesZSamazonka-shieldZSamazonka-shield
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

  • nextToken :: Maybe Text

    The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.

  • maxResults :: Maybe Natural

    The maximum number of resource ARN objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

    This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

  • 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
Eq ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Read ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Show 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 #

NFData ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

Hashable ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

ToJSON ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

AWSRequest 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

type Rep ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

type Rep ListResourcesInProtectionGroup = D1 ('MetaData "ListResourcesInProtectionGroup" "Amazonka.Shield.ListResourcesInProtectionGroup" "libZSservicesZSamazonka-shieldZSamazonka-shield" 'False) (C1 ('MetaCons "ListResourcesInProtectionGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "protectionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListResourcesInProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

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:nextToken:ListResourcesInProtectionGroup', listResourcesInProtectionGroup_nextToken - The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.

$sel:maxResults:ListResourcesInProtectionGroup', listResourcesInProtectionGroup_maxResults - The maximum number of resource ARN objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

$sel:protectionGroupId: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_nextToken :: Lens' ListResourcesInProtectionGroup (Maybe Text) Source #

The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.

listResourcesInProtectionGroup_maxResults :: Lens' ListResourcesInProtectionGroup (Maybe Natural) Source #

The maximum number of resource ARN objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

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

    If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.

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

Generic ListResourcesInProtectionGroupResponse Source # 
Instance details

Defined in Amazonka.Shield.ListResourcesInProtectionGroup

NFData 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" "libZSservicesZSamazonka-shieldZSamazonka-shield" '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:

$sel:nextToken:ListResourcesInProtectionGroup', listResourcesInProtectionGroupResponse_nextToken - If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.

$sel:httpStatus:ListResourcesInProtectionGroupResponse', listResourcesInProtectionGroupResponse_httpStatus - The response's http status code.

$sel:resourceArns: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 #

If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.

listResourcesInProtectionGroupResponse_resourceArns :: Lens' ListResourcesInProtectionGroupResponse [Text] Source #

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