Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearchServerless.ListAccessPolicies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a list of OpenSearch Serverless access policies.

Synopsis

data ListAccessPolicies = ListAccessPolicies' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resource :: Maybe (NonEmpty Text)
- type' :: AccessPolicyType
}
newListAccessPolicies :: AccessPolicyType -> ListAccessPolicies
listAccessPolicies_maxResults :: Lens' ListAccessPolicies (Maybe Natural)
listAccessPolicies_nextToken :: Lens' ListAccessPolicies (Maybe Text)
listAccessPolicies_resource :: Lens' ListAccessPolicies (Maybe (NonEmpty Text))
listAccessPolicies_type :: Lens' ListAccessPolicies AccessPolicyType
data ListAccessPoliciesResponse = ListAccessPoliciesResponse' {
- accessPolicySummaries :: Maybe [AccessPolicySummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAccessPoliciesResponse :: Int -> ListAccessPoliciesResponse
listAccessPoliciesResponse_accessPolicySummaries :: Lens' ListAccessPoliciesResponse (Maybe [AccessPolicySummary])
listAccessPoliciesResponse_nextToken :: Lens' ListAccessPoliciesResponse (Maybe Text)
listAccessPoliciesResponse_httpStatus :: Lens' ListAccessPoliciesResponse Int

Creating a Request

data ListAccessPolicies Source #

See: newListAccessPolicies smart constructor.

Constructors

ListAccessPolicies'

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 ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies 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' :: AccessPolicyType
The type of access policy.

Instances

Instances details

ToJSON ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods toJSON :: ListAccessPolicies -> Value # toEncoding :: ListAccessPolicies -> Encoding # toJSONList :: [ListAccessPolicies] -> Value # toEncodingList :: [ListAccessPolicies] -> Encoding #
ToHeaders ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods toHeaders :: ListAccessPolicies -> [Header] #
ToPath ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods toPath :: ListAccessPolicies -> ByteString #
ToQuery ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods toQuery :: ListAccessPolicies -> QueryString #
AWSRequest ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Associated Types type AWSResponse ListAccessPolicies # Methods request :: (Service -> Service) -> ListAccessPolicies -> Request ListAccessPolicies # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccessPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccessPolicies))) #
Generic ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Associated Types type Rep ListAccessPolicies :: Type -> Type # Methods from :: ListAccessPolicies -> Rep ListAccessPolicies x # to :: Rep ListAccessPolicies x -> ListAccessPolicies #
Read ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods readsPrec :: Int -> ReadS ListAccessPolicies # readList :: ReadS [ListAccessPolicies] # readPrec :: ReadPrec ListAccessPolicies # readListPrec :: ReadPrec [ListAccessPolicies] #
Show ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods showsPrec :: Int -> ListAccessPolicies -> ShowS # show :: ListAccessPolicies -> String # showList :: [ListAccessPolicies] -> ShowS #
NFData ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods rnf :: ListAccessPolicies -> () #
Eq ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods (==) :: ListAccessPolicies -> ListAccessPolicies -> Bool # (/=) :: ListAccessPolicies -> ListAccessPolicies -> Bool #
Hashable ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods hashWithSalt :: Int -> ListAccessPolicies -> Int # hash :: ListAccessPolicies -> Int #
type AWSResponse ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies type AWSResponse ListAccessPolicies = ListAccessPoliciesResponse
type Rep ListAccessPolicies Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies type Rep ListAccessPolicies = D1 ('MetaData "ListAccessPolicies" "Amazonka.OpenSearchServerless.ListAccessPolicies" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListAccessPolicies'" '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 AccessPolicyType))))

newListAccessPolicies Source #

Arguments

:: AccessPolicyType	`ListAccessPolicies`
-> ListAccessPolicies

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

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

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

ListAccessPolicies, listAccessPolicies_type - The type of access policy.

Request Lenses

listAccessPolicies_maxResults :: Lens' ListAccessPolicies (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.

listAccessPolicies_nextToken :: Lens' ListAccessPolicies (Maybe Text) Source #

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

listAccessPolicies_resource :: Lens' ListAccessPolicies (Maybe (NonEmpty Text)) Source #

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

listAccessPolicies_type :: Lens' ListAccessPolicies AccessPolicyType Source #

The type of access policy.

Destructuring the Response

data ListAccessPoliciesResponse Source #

See: newListAccessPoliciesResponse smart constructor.

Constructors

ListAccessPoliciesResponse'
Fields accessPolicySummaries :: Maybe [AccessPolicySummary] Details about the requested access policies. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Associated Types type Rep ListAccessPoliciesResponse :: Type -> Type # Methods from :: ListAccessPoliciesResponse -> Rep ListAccessPoliciesResponse x # to :: Rep ListAccessPoliciesResponse x -> ListAccessPoliciesResponse #
Read ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods readsPrec :: Int -> ReadS ListAccessPoliciesResponse # readList :: ReadS [ListAccessPoliciesResponse] # readPrec :: ReadPrec ListAccessPoliciesResponse # readListPrec :: ReadPrec [ListAccessPoliciesResponse] #
Show ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods showsPrec :: Int -> ListAccessPoliciesResponse -> ShowS # show :: ListAccessPoliciesResponse -> String # showList :: [ListAccessPoliciesResponse] -> ShowS #
NFData ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods rnf :: ListAccessPoliciesResponse -> () #
Eq ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies Methods (==) :: ListAccessPoliciesResponse -> ListAccessPoliciesResponse -> Bool # (/=) :: ListAccessPoliciesResponse -> ListAccessPoliciesResponse -> Bool #
type Rep ListAccessPoliciesResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListAccessPolicies type Rep ListAccessPoliciesResponse = D1 ('MetaData "ListAccessPoliciesResponse" "Amazonka.OpenSearchServerless.ListAccessPolicies" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListAccessPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPolicySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccessPolicySummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAccessPoliciesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAccessPoliciesResponse'`
-> ListAccessPoliciesResponse

Create a value of ListAccessPoliciesResponse 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:accessPolicySummaries:ListAccessPoliciesResponse', listAccessPoliciesResponse_accessPolicySummaries - Details about the requested access policies.

ListAccessPolicies, listAccessPoliciesResponse_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:httpStatus:ListAccessPoliciesResponse', listAccessPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listAccessPoliciesResponse_accessPolicySummaries :: Lens' ListAccessPoliciesResponse (Maybe [AccessPolicySummary]) Source #

Details about the requested access policies.

listAccessPoliciesResponse_nextToken :: Lens' ListAccessPoliciesResponse (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.

listAccessPoliciesResponse_httpStatus :: Lens' ListAccessPoliciesResponse Int Source #

The response's http status code.