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.ConnectCases.BatchGetField

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the description for the list of fields in the request parameters.

Creating a Request

data BatchGetField Source #

See: newBatchGetField smart constructor.

Constructors

BatchGetField'
Fields domainId :: Text The unique identifier of the Cases domain. fields :: NonEmpty FieldIdentifier A list of unique field identifiers.

Instances

Instances details

ToJSON BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods toJSON :: BatchGetField -> Value # toEncoding :: BatchGetField -> Encoding # toJSONList :: [BatchGetField] -> Value # toEncodingList :: [BatchGetField] -> Encoding #
ToHeaders BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods toHeaders :: BatchGetField -> [Header] #
ToPath BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods toPath :: BatchGetField -> ByteString #
ToQuery BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods toQuery :: BatchGetField -> QueryString #
AWSRequest BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Associated Types type AWSResponse BatchGetField # Methods request :: (Service -> Service) -> BatchGetField -> Request BatchGetField # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchGetField -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchGetField))) #
Generic BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Associated Types type Rep BatchGetField :: Type -> Type # Methods from :: BatchGetField -> Rep BatchGetField x # to :: Rep BatchGetField x -> BatchGetField #
Read BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods readsPrec :: Int -> ReadS BatchGetField # readList :: ReadS [BatchGetField] # readPrec :: ReadPrec BatchGetField # readListPrec :: ReadPrec [BatchGetField] #
Show BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods showsPrec :: Int -> BatchGetField -> ShowS # show :: BatchGetField -> String # showList :: [BatchGetField] -> ShowS #
NFData BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods rnf :: BatchGetField -> () #
Eq BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods (==) :: BatchGetField -> BatchGetField -> Bool # (/=) :: BatchGetField -> BatchGetField -> Bool #
Hashable BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods hashWithSalt :: Int -> BatchGetField -> Int # hash :: BatchGetField -> Int #
type AWSResponse BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField type AWSResponse BatchGetField = BatchGetFieldResponse
type Rep BatchGetField Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField type Rep BatchGetField = D1 ('MetaData "BatchGetField" "Amazonka.ConnectCases.BatchGetField" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "BatchGetField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty FieldIdentifier))))

newBatchGetField Source #

Arguments

:: Text	`BatchGetField`
-> NonEmpty FieldIdentifier	`BatchGetField`
-> BatchGetField

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

BatchGetField, batchGetField_domainId - The unique identifier of the Cases domain.

BatchGetField, batchGetField_fields - A list of unique field identifiers.

Request Lenses

batchGetField_domainId :: Lens' BatchGetField Text Source #

The unique identifier of the Cases domain.

batchGetField_fields :: Lens' BatchGetField (NonEmpty FieldIdentifier) Source #

A list of unique field identifiers.

Destructuring the Response

data BatchGetFieldResponse Source #

See: newBatchGetFieldResponse smart constructor.

Constructors

BatchGetFieldResponse'
Fields httpStatus :: Int The response's http status code. errors :: [FieldError] A list of field errors. fields :: [GetFieldResponse] A list of detailed field information.

Instances

Instances details

Generic BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Associated Types type Rep BatchGetFieldResponse :: Type -> Type # Methods from :: BatchGetFieldResponse -> Rep BatchGetFieldResponse x # to :: Rep BatchGetFieldResponse x -> BatchGetFieldResponse #
Read BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods readsPrec :: Int -> ReadS BatchGetFieldResponse # readList :: ReadS [BatchGetFieldResponse] # readPrec :: ReadPrec BatchGetFieldResponse # readListPrec :: ReadPrec [BatchGetFieldResponse] #
Show BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods showsPrec :: Int -> BatchGetFieldResponse -> ShowS # show :: BatchGetFieldResponse -> String # showList :: [BatchGetFieldResponse] -> ShowS #
NFData BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods rnf :: BatchGetFieldResponse -> () #
Eq BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField Methods (==) :: BatchGetFieldResponse -> BatchGetFieldResponse -> Bool # (/=) :: BatchGetFieldResponse -> BatchGetFieldResponse -> Bool #
type Rep BatchGetFieldResponse Source #
Instance details Defined in Amazonka.ConnectCases.BatchGetField type Rep BatchGetFieldResponse = D1 ('MetaData "BatchGetFieldResponse" "Amazonka.ConnectCases.BatchGetField" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "BatchGetFieldResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FieldError]) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GetFieldResponse]))))

newBatchGetFieldResponse Source #

Arguments

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

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

$sel:errors:BatchGetFieldResponse', batchGetFieldResponse_errors - A list of field errors.

BatchGetField, batchGetFieldResponse_fields - A list of detailed field information.

Response Lenses

batchGetFieldResponse_httpStatus :: Lens' BatchGetFieldResponse Int Source #

The response's http status code.

batchGetFieldResponse_errors :: Lens' BatchGetFieldResponse [FieldError] Source #

A list of field errors.

batchGetFieldResponse_fields :: Lens' BatchGetFieldResponse [GetFieldResponse] Source #

A list of detailed field information.