libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
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.CloudSearch.DescribeServiceAccessPolicies

Description

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Synopsis

Creating a Request

data DescribeServiceAccessPolicies Source #

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See: newDescribeServiceAccessPolicies smart constructor.

Constructors

DescribeServiceAccessPolicies' 

Fields

  • deployed :: Maybe Bool

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

  • domainName :: Text

    The name of the domain you want to describe.

Instances

Instances details
Eq DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

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

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

Read DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

readsPrec :: Int -> ReadS DescribeServiceAccessPolicies #

readList :: ReadS [DescribeServiceAccessPolicies] #

readPrec :: ReadPrec DescribeServiceAccessPolicies #

readListPrec :: ReadPrec [DescribeServiceAccessPolicies] #

Show DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

showsPrec :: Int -> DescribeServiceAccessPolicies -> ShowS #

show :: DescribeServiceAccessPolicies -> String #

showList :: [DescribeServiceAccessPolicies] -> ShowS #

Generic DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Associated Types

type Rep DescribeServiceAccessPolicies :: Type -> Type #

Methods

from :: DescribeServiceAccessPolicies -> Rep DescribeServiceAccessPolicies x #

to :: Rep DescribeServiceAccessPolicies x -> DescribeServiceAccessPolicies #

NFData DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

rnf :: DescribeServiceAccessPolicies -> () #

Hashable DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

hashWithSalt :: Int -> DescribeServiceAccessPolicies -> Int #

hash :: DescribeServiceAccessPolicies -> Int #

AWSRequest DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Associated Types

type AWSResponse DescribeServiceAccessPolicies #

Methods

request :: DescribeServiceAccessPolicies -> Request DescribeServiceAccessPolicies #

response :: MonadResource m => Logger -> Service -> Proxy DescribeServiceAccessPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeServiceAccessPolicies))) #

ToHeaders DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

toHeaders :: DescribeServiceAccessPolicies -> [Header] #

ToPath DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

toPath :: DescribeServiceAccessPolicies -> ByteString #

ToQuery DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

toQuery :: DescribeServiceAccessPolicies -> QueryString #

type Rep DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

type Rep DescribeServiceAccessPolicies = D1 ('MetaData "DescribeServiceAccessPolicies" "Amazonka.CloudSearch.DescribeServiceAccessPolicies" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeServiceAccessPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeServiceAccessPolicies Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

type AWSResponse DescribeServiceAccessPolicies = DescribeServiceAccessPoliciesResponse

newDescribeServiceAccessPolicies Source #

Arguments

:: Text

$sel:domainName:DescribeServiceAccessPolicies'

-> DescribeServiceAccessPolicies 

Create a value of DescribeServiceAccessPolicies 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:deployed:DescribeServiceAccessPolicies', describeServiceAccessPolicies_deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

$sel:domainName:DescribeServiceAccessPolicies', describeServiceAccessPolicies_domainName - The name of the domain you want to describe.

Request Lenses

describeServiceAccessPolicies_deployed :: Lens' DescribeServiceAccessPolicies (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeServiceAccessPolicies_domainName :: Lens' DescribeServiceAccessPolicies Text Source #

The name of the domain you want to describe.

Destructuring the Response

data DescribeServiceAccessPoliciesResponse Source #

The result of a DescribeServiceAccessPolicies request.

See: newDescribeServiceAccessPoliciesResponse smart constructor.

Constructors

DescribeServiceAccessPoliciesResponse' 

Fields

Instances

Instances details
Eq DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

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

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

Read DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

readsPrec :: Int -> ReadS DescribeServiceAccessPoliciesResponse #

readList :: ReadS [DescribeServiceAccessPoliciesResponse] #

readPrec :: ReadPrec DescribeServiceAccessPoliciesResponse #

readListPrec :: ReadPrec [DescribeServiceAccessPoliciesResponse] #

Show DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

showsPrec :: Int -> DescribeServiceAccessPoliciesResponse -> ShowS #

show :: DescribeServiceAccessPoliciesResponse -> String #

showList :: [DescribeServiceAccessPoliciesResponse] -> ShowS #

Generic DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Associated Types

type Rep DescribeServiceAccessPoliciesResponse :: Type -> Type #

Methods

from :: DescribeServiceAccessPoliciesResponse -> Rep DescribeServiceAccessPoliciesResponse x #

to :: Rep DescribeServiceAccessPoliciesResponse x -> DescribeServiceAccessPoliciesResponse #

NFData DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

Methods

rnf :: DescribeServiceAccessPoliciesResponse -> () #

type Rep DescribeServiceAccessPoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeServiceAccessPolicies

type Rep DescribeServiceAccessPoliciesResponse = D1 ('MetaData "DescribeServiceAccessPoliciesResponse" "Amazonka.CloudSearch.DescribeServiceAccessPolicies" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeServiceAccessPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessPoliciesStatus)))

newDescribeServiceAccessPoliciesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeServiceAccessPoliciesResponse'

-> AccessPoliciesStatus

$sel:accessPolicies:DescribeServiceAccessPoliciesResponse'

-> DescribeServiceAccessPoliciesResponse 

Create a value of DescribeServiceAccessPoliciesResponse 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:httpStatus:DescribeServiceAccessPoliciesResponse', describeServiceAccessPoliciesResponse_httpStatus - The response's http status code.

$sel:accessPolicies:DescribeServiceAccessPoliciesResponse', describeServiceAccessPoliciesResponse_accessPolicies - The access rules configured for the domain specified in the request.

Response Lenses

describeServiceAccessPoliciesResponse_httpStatus :: Lens' DescribeServiceAccessPoliciesResponse Int Source #

The response's http status code.

describeServiceAccessPoliciesResponse_accessPolicies :: Lens' DescribeServiceAccessPoliciesResponse AccessPoliciesStatus Source #

The access rules configured for the domain specified in the request.