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

Description

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Synopsis

Creating a Request

data DescribeExpressions Source #

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See: newDescribeExpressions smart constructor.

Constructors

DescribeExpressions' 

Fields

  • deployed :: Maybe Bool

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

  • expressionNames :: Maybe [Text]

    Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

  • domainName :: Text

    The name of the domain you want to describe.

Instances

Instances details
Eq DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

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

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

Read DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

readsPrec :: Int -> ReadS DescribeExpressions #

readList :: ReadS [DescribeExpressions] #

readPrec :: ReadPrec DescribeExpressions #

readListPrec :: ReadPrec [DescribeExpressions] #

Show DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

showsPrec :: Int -> DescribeExpressions -> ShowS #

show :: DescribeExpressions -> String #

showList :: [DescribeExpressions] -> ShowS #

Generic DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Associated Types

type Rep DescribeExpressions :: Type -> Type #

Methods

from :: DescribeExpressions -> Rep DescribeExpressions x #

to :: Rep DescribeExpressions x -> DescribeExpressions #

NFData DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

rnf :: DescribeExpressions -> () #

Hashable DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

hashWithSalt :: Int -> DescribeExpressions -> Int #

hash :: DescribeExpressions -> Int #

AWSRequest DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Associated Types

type AWSResponse DescribeExpressions #

Methods

request :: DescribeExpressions -> Request DescribeExpressions #

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

ToHeaders DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

toHeaders :: DescribeExpressions -> [Header] #

ToPath DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

toPath :: DescribeExpressions -> ByteString #

ToQuery DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

toQuery :: DescribeExpressions -> QueryString #

type Rep DescribeExpressions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

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

Defined in Amazonka.CloudSearch.DescribeExpressions

type AWSResponse DescribeExpressions = DescribeExpressionsResponse

newDescribeExpressions Source #

Arguments

:: Text

$sel:domainName:DescribeExpressions'

-> DescribeExpressions 

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

$sel:expressionNames:DescribeExpressions', describeExpressions_expressionNames - Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

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

Request Lenses

describeExpressions_deployed :: Lens' DescribeExpressions (Maybe Bool) Source #

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

describeExpressions_expressionNames :: Lens' DescribeExpressions (Maybe [Text]) Source #

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

describeExpressions_domainName :: Lens' DescribeExpressions Text Source #

The name of the domain you want to describe.

Destructuring the Response

data DescribeExpressionsResponse Source #

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

See: newDescribeExpressionsResponse smart constructor.

Constructors

DescribeExpressionsResponse' 

Fields

Instances

Instances details
Eq DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

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

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

Read DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

readsPrec :: Int -> ReadS DescribeExpressionsResponse #

readList :: ReadS [DescribeExpressionsResponse] #

readPrec :: ReadPrec DescribeExpressionsResponse #

readListPrec :: ReadPrec [DescribeExpressionsResponse] #

Show DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

showsPrec :: Int -> DescribeExpressionsResponse -> ShowS #

show :: DescribeExpressionsResponse -> String #

showList :: [DescribeExpressionsResponse] -> ShowS #

Generic DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Associated Types

type Rep DescribeExpressionsResponse :: Type -> Type #

Methods

from :: DescribeExpressionsResponse -> Rep DescribeExpressionsResponse x #

to :: Rep DescribeExpressionsResponse x -> DescribeExpressionsResponse #

NFData DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

Methods

rnf :: DescribeExpressionsResponse -> () #

type Rep DescribeExpressionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeExpressions

type Rep DescribeExpressionsResponse = D1 ('MetaData "DescribeExpressionsResponse" "Amazonka.CloudSearch.DescribeExpressions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeExpressionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "expressions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExpressionStatus])))

newDescribeExpressionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeExpressionsResponse'

-> DescribeExpressionsResponse 

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

$sel:expressions:DescribeExpressionsResponse', describeExpressionsResponse_expressions - The expressions configured for the domain.

Response Lenses

describeExpressionsResponse_httpStatus :: Lens' DescribeExpressionsResponse Int Source #

The response's http status code.

describeExpressionsResponse_expressions :: Lens' DescribeExpressionsResponse [ExpressionStatus] Source #

The expressions configured for the domain.