Amazonka.ConnectCases.CreateField

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

Creating a Request

data CreateField

See: newCreateField smart constructor.

Constructors

CreateField'

Fields

• description :: Maybe Text

  The description of the field.

• domainId :: Text

  The unique identifier of the Cases domain.

• name :: Text

  The name of the field.

• type' :: FieldType

  Defines the data type, some system constraints, and default display of the field.

Instances

ToJSON CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

toJSON :: CreateField -> Value

toEncoding :: CreateField -> Encoding

toJSONList :: [CreateField] -> Value

toEncodingList :: [CreateField] -> Encoding

ToHeaders CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

toHeaders :: CreateField -> [Header]

ToPath CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

toPath :: CreateField -> ByteString

ToQuery CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

toQuery :: CreateField -> QueryString

AWSRequest CreateField

Defined in Amazonka.ConnectCases.CreateField

Associated Types

type AWSResponse CreateField

Methods

request :: (Service -> Service) -> CreateField -> Request CreateField

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateField -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateField)))

Generic CreateField

Defined in Amazonka.ConnectCases.CreateField

Associated Types

type Rep CreateField :: Type -> Type

Methods

from :: CreateField -> Rep CreateField x

to :: Rep CreateField x -> CreateField

Read CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

readsPrec :: Int -> ReadS CreateField

readList :: ReadS [CreateField]

readPrec :: ReadPrec CreateField

readListPrec :: ReadPrec [CreateField]

Show CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

showsPrec :: Int -> CreateField -> ShowS

show :: CreateField -> String

showList :: [CreateField] -> ShowS

NFData CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

rnf :: CreateField -> ()

Eq CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

(==) :: CreateField -> CreateField -> Bool

(/=) :: CreateField -> CreateField -> Bool

Hashable CreateField

Defined in Amazonka.ConnectCases.CreateField

Methods

hashWithSalt :: Int -> CreateField -> Int

hash :: CreateField -> Int

type AWSResponse CreateField

Defined in Amazonka.ConnectCases.CreateField

type AWSResponse CreateField = CreateFieldResponse

type Rep CreateField

Defined in Amazonka.ConnectCases.CreateField

type Rep CreateField = D1 ('MetaData "CreateField" "Amazonka.ConnectCases.CreateField" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "CreateField'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FieldType))))

newCreateField

Arguments

:: Text

CreateField

-> Text

CreateField

-> FieldType

CreateField

-> CreateField

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

CreateField, createField_description - The description of the field.

CreateField, createField_domainId - The unique identifier of the Cases domain.

CreateField, createField_name - The name of the field.

CreateField, createField_type - Defines the data type, some system constraints, and default display of the field.

Request Lenses

createField_description :: Lens' CreateField (Maybe Text)

The description of the field.

createField_domainId :: Lens' CreateField Text

The unique identifier of the Cases domain.

createField_name :: Lens' CreateField Text

The name of the field.

createField_type :: Lens' CreateField FieldType

Defines the data type, some system constraints, and default display of the field.

Destructuring the Response

data CreateFieldResponse

See: newCreateFieldResponse smart constructor.

Constructors

CreateFieldResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• fieldArn :: Text

  The Amazon Resource Name (ARN) of the field.

• fieldId :: Text

  The unique identifier of a field.

Instances

Generic CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

Associated Types

type Rep CreateFieldResponse :: Type -> Type

Methods

from :: CreateFieldResponse -> Rep CreateFieldResponse x

to :: Rep CreateFieldResponse x -> CreateFieldResponse

Read CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

Methods

readsPrec :: Int -> ReadS CreateFieldResponse

readList :: ReadS [CreateFieldResponse]

readPrec :: ReadPrec CreateFieldResponse

readListPrec :: ReadPrec [CreateFieldResponse]

Show CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

Methods

showsPrec :: Int -> CreateFieldResponse -> ShowS

show :: CreateFieldResponse -> String

showList :: [CreateFieldResponse] -> ShowS

NFData CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

Methods

rnf :: CreateFieldResponse -> ()

Eq CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

Methods

(==) :: CreateFieldResponse -> CreateFieldResponse -> Bool

(/=) :: CreateFieldResponse -> CreateFieldResponse -> Bool

type Rep CreateFieldResponse

Defined in Amazonka.ConnectCases.CreateField

type Rep CreateFieldResponse = D1 ('MetaData "CreateFieldResponse" "Amazonka.ConnectCases.CreateField" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "CreateFieldResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "fieldArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fieldId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateFieldResponse

Arguments

:: Int

$sel:httpStatus:CreateFieldResponse'

-> Text

CreateFieldResponse

-> Text

CreateFieldResponse

-> CreateFieldResponse

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

CreateFieldResponse, createFieldResponse_fieldArn - The Amazon Resource Name (ARN) of the field.

CreateFieldResponse, createFieldResponse_fieldId - The unique identifier of a field.

Response Lenses

createFieldResponse_httpStatus :: Lens' CreateFieldResponse Int

The response's http status code.

createFieldResponse_fieldArn :: Lens' CreateFieldResponse Text

The Amazon Resource Name (ARN) of the field.

createFieldResponse_fieldId :: Lens' CreateFieldResponse Text

The unique identifier of a field.