amazonka-wafv2-2.0: Amazon WAFV2 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.WAFV2.GetRuleGroup

Description

Retrieves the specified RuleGroup.

Synopsis

Creating a Request

data GetRuleGroup Source #

See: newGetRuleGroup smart constructor.

Constructors

GetRuleGroup' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the entity.

  • id :: Maybe Text

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

  • name :: Maybe Text

    The name of the rule group. You cannot change the name of a rule group after you create it.

  • scope :: Maybe Scope

    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    • API and SDKs - For all calls, use the Region endpoint us-east-1.

Instances

Instances details
ToJSON GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

toJSON :: GetRuleGroup -> Value #

toEncoding :: GetRuleGroup -> Encoding #

toJSONList :: [GetRuleGroup] -> Value #

toEncodingList :: [GetRuleGroup] -> Encoding #

ToHeaders GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

toHeaders :: GetRuleGroup -> [Header] #

ToPath GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

toPath :: GetRuleGroup -> ByteString #

ToQuery GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

toQuery :: GetRuleGroup -> QueryString #

AWSRequest GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Associated Types

type AWSResponse GetRuleGroup #

Methods

request :: (Service -> Service) -> GetRuleGroup -> Request GetRuleGroup #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRuleGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRuleGroup))) #

Generic GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Associated Types

type Rep GetRuleGroup :: Type -> Type #

Methods

from :: GetRuleGroup -> Rep GetRuleGroup x #

to :: Rep GetRuleGroup x -> GetRuleGroup #

Read GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

readsPrec :: Int -> ReadS GetRuleGroup #

readList :: ReadS [GetRuleGroup] #

readPrec :: ReadPrec GetRuleGroup #

readListPrec :: ReadPrec [GetRuleGroup] #

Show GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

showsPrec :: Int -> GetRuleGroup -> ShowS #

show :: GetRuleGroup -> String #

showList :: [GetRuleGroup] -> ShowS #

NFData GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

rnf :: GetRuleGroup -> () #

Eq GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

(==) :: GetRuleGroup -> GetRuleGroup -> Bool #

(/=) :: GetRuleGroup -> GetRuleGroup -> Bool #

Hashable GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

hashWithSalt :: Int -> GetRuleGroup -> Int #

hash :: GetRuleGroup -> Int #

type AWSResponse GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

type AWSResponse GetRuleGroup = GetRuleGroupResponse
type Rep GetRuleGroup Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

type Rep GetRuleGroup = D1 ('MetaData "GetRuleGroup" "Amazonka.WAFV2.GetRuleGroup" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetRuleGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Scope)))))

newGetRuleGroup :: GetRuleGroup Source #

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

GetRuleGroup, getRuleGroup_arn - The Amazon Resource Name (ARN) of the entity.

GetRuleGroup, getRuleGroup_id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

GetRuleGroup, getRuleGroup_name - The name of the rule group. You cannot change the name of a rule group after you create it.

GetRuleGroup, getRuleGroup_scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Request Lenses

getRuleGroup_arn :: Lens' GetRuleGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the entity.

getRuleGroup_id :: Lens' GetRuleGroup (Maybe Text) Source #

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

getRuleGroup_name :: Lens' GetRuleGroup (Maybe Text) Source #

The name of the rule group. You cannot change the name of a rule group after you create it.

getRuleGroup_scope :: Lens' GetRuleGroup (Maybe Scope) Source #

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Destructuring the Response

data GetRuleGroupResponse Source #

See: newGetRuleGroupResponse smart constructor.

Constructors

GetRuleGroupResponse' 

Fields

  • lockToken :: Maybe Text

    A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • ruleGroup :: Maybe RuleGroup
     
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Associated Types

type Rep GetRuleGroupResponse :: Type -> Type #

Methods

from :: GetRuleGroupResponse -> Rep GetRuleGroupResponse x #

to :: Rep GetRuleGroupResponse x -> GetRuleGroupResponse #

Read GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

readsPrec :: Int -> ReadS GetRuleGroupResponse #

readList :: ReadS [GetRuleGroupResponse] #

readPrec :: ReadPrec GetRuleGroupResponse #

readListPrec :: ReadPrec [GetRuleGroupResponse] #

Show GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

showsPrec :: Int -> GetRuleGroupResponse -> ShowS #

show :: GetRuleGroupResponse -> String #

showList :: [GetRuleGroupResponse] -> ShowS #

NFData GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

rnf :: GetRuleGroupResponse -> () #

Eq GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

Methods

(==) :: GetRuleGroupResponse -> GetRuleGroupResponse -> Bool #

(/=) :: GetRuleGroupResponse -> GetRuleGroupResponse -> Bool #

type Rep GetRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetRuleGroup

type Rep GetRuleGroupResponse = D1 ('MetaData "GetRuleGroupResponse" "Amazonka.WAFV2.GetRuleGroup" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetRuleGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ruleGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRuleGroupResponse Source #

Arguments

:: Int

$sel:httpStatus:GetRuleGroupResponse'

-> GetRuleGroupResponse 

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

GetRuleGroupResponse, getRuleGroupResponse_lockToken - A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

$sel:ruleGroup:GetRuleGroupResponse', getRuleGroupResponse_ruleGroup -

$sel:httpStatus:GetRuleGroupResponse', getRuleGroupResponse_httpStatus - The response's http status code.

Response Lenses

getRuleGroupResponse_lockToken :: Lens' GetRuleGroupResponse (Maybe Text) Source #

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

getRuleGroupResponse_ruleGroup :: Lens' GetRuleGroupResponse (Maybe RuleGroup) Source #

getRuleGroupResponse_httpStatus :: Lens' GetRuleGroupResponse Int Source #

The response's http status code.