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

Description

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Synopsis

Creating a Request

data ListSecurityConfigs Source #

See: newListSecurityConfigs smart constructor.

Constructors

ListSecurityConfigs' 

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 ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.

  • type' :: SecurityConfigType

    The type of security configuration.

Instances

Instances details
ToJSON ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

ToHeaders ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

ToPath ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

ToQuery ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

AWSRequest ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Associated Types

type AWSResponse ListSecurityConfigs #

Generic ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Associated Types

type Rep ListSecurityConfigs :: Type -> Type #

Read ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Show ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

NFData ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Methods

rnf :: ListSecurityConfigs -> () #

Eq ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Hashable ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

type AWSResponse ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

type Rep ListSecurityConfigs Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

type Rep ListSecurityConfigs = D1 ('MetaData "ListSecurityConfigs" "Amazonka.OpenSearchServerless.ListSecurityConfigs" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListSecurityConfigs'" '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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecurityConfigType))))

newListSecurityConfigs Source #

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

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

ListSecurityConfigs, listSecurityConfigs_type - The type of security configuration.

Request Lenses

listSecurityConfigs_maxResults :: Lens' ListSecurityConfigs (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.

listSecurityConfigs_nextToken :: Lens' ListSecurityConfigs (Maybe Text) Source #

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

Destructuring the Response

data ListSecurityConfigsResponse Source #

See: newListSecurityConfigsResponse smart constructor.

Constructors

ListSecurityConfigsResponse' 

Fields

Instances

Instances details
Generic ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Associated Types

type Rep ListSecurityConfigsResponse :: Type -> Type #

Read ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Show ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

NFData ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

Eq ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

type Rep ListSecurityConfigsResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.ListSecurityConfigs

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

newListSecurityConfigsResponse Source #

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

ListSecurityConfigs, listSecurityConfigsResponse_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:securityConfigSummaries:ListSecurityConfigsResponse', listSecurityConfigsResponse_securityConfigSummaries - Details about the security configurations in your account.

$sel:httpStatus:ListSecurityConfigsResponse', listSecurityConfigsResponse_httpStatus - The response's http status code.

Response Lenses

listSecurityConfigsResponse_nextToken :: Lens' ListSecurityConfigsResponse (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.