amazonka-opensearchserverless-2.0: Amazon OpenSearch Service Serverless 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.OpenSearchServerless.ListSecurityPolicies

Description

Returns information about configured OpenSearch Serverless security policies.

Synopsis

Creating a Request

data ListSecurityPolicies Source #

See: newListSecurityPolicies smart constructor.

Constructors

ListSecurityPolicies' 

Fields

  • maxResults :: Maybe Natural

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

  • nextToken :: Maybe Text

    If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

  • resource :: Maybe (NonEmpty Text)

    Resource filters (can be collection or indexes) that policies can apply to.

  • type' :: SecurityPolicyType

    The type of policy.

Instances

Instances details
ToJSON ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

ToHeaders ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

ToPath ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

ToQuery ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

AWSRequest ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Associated Types

type AWSResponse ListSecurityPolicies #

Generic ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Associated Types

type Rep ListSecurityPolicies :: Type -> Type #

Read ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Show ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

NFData ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Methods

rnf :: ListSecurityPolicies -> () #

Eq ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Hashable ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

type AWSResponse ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

type Rep ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

type Rep ListSecurityPolicies = D1 ('MetaData "ListSecurityPolicies" "Amazonka.OpenSearchServerless.ListSecurityPolicies" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListSecurityPolicies'" '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 "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecurityPolicyType))))

newListSecurityPolicies Source #

Create a value of ListSecurityPolicies 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:ListSecurityPolicies', listSecurityPolicies_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

ListSecurityPolicies, listSecurityPolicies_nextToken - If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

$sel:resource:ListSecurityPolicies', listSecurityPolicies_resource - Resource filters (can be collection or indexes) that policies can apply to.

ListSecurityPolicies, listSecurityPolicies_type - The type of policy.

Request Lenses

listSecurityPolicies_maxResults :: Lens' ListSecurityPolicies (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

listSecurityPolicies_nextToken :: Lens' ListSecurityPolicies (Maybe Text) Source #

If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

listSecurityPolicies_resource :: Lens' ListSecurityPolicies (Maybe (NonEmpty Text)) Source #

Resource filters (can be collection or indexes) that policies can apply to.

Destructuring the Response

data ListSecurityPoliciesResponse Source #

See: newListSecurityPoliciesResponse smart constructor.

Constructors

ListSecurityPoliciesResponse' 

Fields

Instances

Instances details
Generic ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Associated Types

type Rep ListSecurityPoliciesResponse :: Type -> Type #

Read ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Show ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

NFData ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

Eq ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

type Rep ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityPolicies

type Rep ListSecurityPoliciesResponse = D1 ('MetaData "ListSecurityPoliciesResponse" "Amazonka.OpenSearchServerless.ListSecurityPolicies" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListSecurityPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "securityPolicySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityPolicySummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSecurityPoliciesResponse Source #

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

ListSecurityPolicies, listSecurityPoliciesResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:securityPolicySummaries:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_securityPolicySummaries - Details about the security policies in your account.

$sel:httpStatus:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listSecurityPoliciesResponse_nextToken :: Lens' ListSecurityPoliciesResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.