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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the details for the requested layout.

Synopsis

data GetLayout = GetLayout' {
- domainId :: Text
- layoutId :: Text
}
newGetLayout :: Text -> Text -> GetLayout
getLayout_domainId :: Lens' GetLayout Text
getLayout_layoutId :: Lens' GetLayout Text
data GetLayoutResponse = GetLayoutResponse' {
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- content :: LayoutContent
- layoutArn :: Text
- layoutId :: Text
- name :: Text
}
newGetLayoutResponse :: Int -> LayoutContent -> Text -> Text -> Text -> GetLayoutResponse
getLayoutResponse_tags :: Lens' GetLayoutResponse (Maybe (HashMap Text Text))
getLayoutResponse_httpStatus :: Lens' GetLayoutResponse Int
getLayoutResponse_content :: Lens' GetLayoutResponse LayoutContent
getLayoutResponse_layoutArn :: Lens' GetLayoutResponse Text
getLayoutResponse_layoutId :: Lens' GetLayoutResponse Text
getLayoutResponse_name :: Lens' GetLayoutResponse Text

Creating a Request

data GetLayout Source #

See: newGetLayout smart constructor.

Constructors

GetLayout'
Fields domainId :: Text The unique identifier of the Cases domain. layoutId :: Text The unique identifier of the layout.

Instances

Instances details

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

newGetLayout Source #

Arguments

:: Text	`GetLayout`
-> Text	`GetLayout`
-> GetLayout

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

GetLayout, getLayout_domainId - The unique identifier of the Cases domain.

GetLayout, getLayout_layoutId - The unique identifier of the layout.

Request Lenses

getLayout_domainId :: Lens' GetLayout Text Source #

The unique identifier of the Cases domain.

getLayout_layoutId :: Lens' GetLayout Text Source #

The unique identifier of the layout.

Destructuring the Response

data GetLayoutResponse Source #

See: newGetLayoutResponse smart constructor.

Constructors

GetLayoutResponse'

Fields

tags :: Maybe (HashMap Text Text)
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
httpStatus :: Int
The response's http status code.
content :: LayoutContent
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
layoutArn :: Text
The Amazon Resource Name (ARN) of the newly created layout.
layoutId :: Text
The unique identifier of the layout.
name :: Text
The name of the layout. It must be unique.

Instances

Instances details

Generic GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout Associated Types type Rep GetLayoutResponse :: Type -> Type # Methods from :: GetLayoutResponse -> Rep GetLayoutResponse x # to :: Rep GetLayoutResponse x -> GetLayoutResponse #
Read GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout Methods readsPrec :: Int -> ReadS GetLayoutResponse # readList :: ReadS [GetLayoutResponse] # readPrec :: ReadPrec GetLayoutResponse # readListPrec :: ReadPrec [GetLayoutResponse] #
Show GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout Methods showsPrec :: Int -> GetLayoutResponse -> ShowS # show :: GetLayoutResponse -> String # showList :: [GetLayoutResponse] -> ShowS #
NFData GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout Methods rnf :: GetLayoutResponse -> () #
Eq GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout Methods (==) :: GetLayoutResponse -> GetLayoutResponse -> Bool # (/=) :: GetLayoutResponse -> GetLayoutResponse -> Bool #
type Rep GetLayoutResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetLayout type Rep GetLayoutResponse = D1 ('MetaData "GetLayoutResponse" "Amazonka.ConnectCases.GetLayout" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "GetLayoutResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LayoutContent))) :: (S1 ('MetaSel ('Just "layoutArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "layoutId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetLayoutResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetLayoutResponse'`
-> LayoutContent	`GetLayoutResponse`
-> Text	`GetLayoutResponse`
-> Text	`GetLayout`
-> Text	`GetLayoutResponse`
-> GetLayoutResponse

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

GetLayoutResponse, getLayoutResponse_tags - A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

$sel:httpStatus:GetLayoutResponse', getLayoutResponse_httpStatus - The response's http status code.

GetLayoutResponse, getLayoutResponse_content - Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

GetLayoutResponse, getLayoutResponse_layoutArn - The Amazon Resource Name (ARN) of the newly created layout.

GetLayout, getLayoutResponse_layoutId - The unique identifier of the layout.

GetLayoutResponse, getLayoutResponse_name - The name of the layout. It must be unique.

Response Lenses

getLayoutResponse_tags :: Lens' GetLayoutResponse (Maybe (HashMap Text Text)) Source #

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

getLayoutResponse_httpStatus :: Lens' GetLayoutResponse Int Source #

The response's http status code.

getLayoutResponse_content :: Lens' GetLayoutResponse LayoutContent Source #

Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

getLayoutResponse_layoutArn :: Lens' GetLayoutResponse Text Source #

The Amazon Resource Name (ARN) of the newly created layout.

getLayoutResponse_layoutId :: Lens' GetLayoutResponse Text Source #

The unique identifier of the layout.

getLayoutResponse_name :: Lens' GetLayoutResponse Text Source #

The name of the layout. It must be unique.