Amazonka.ConnectCases.ListLayouts

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Creating a Request

data ListLayouts

See: newListLayouts smart constructor.

Constructors

ListLayouts'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to return per page.

• nextToken :: Maybe Text

  The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• domainId :: Text

  The unique identifier of the Cases domain.

Instances

ToJSON ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

toJSON :: ListLayouts -> Value

toEncoding :: ListLayouts -> Encoding

toJSONList :: [ListLayouts] -> Value

toEncodingList :: [ListLayouts] -> Encoding

ToHeaders ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

toHeaders :: ListLayouts -> [Header]

ToPath ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

toPath :: ListLayouts -> ByteString

ToQuery ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

toQuery :: ListLayouts -> QueryString

AWSRequest ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Associated Types

type AWSResponse ListLayouts

Methods

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

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

Generic ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Associated Types

type Rep ListLayouts :: Type -> Type

Methods

from :: ListLayouts -> Rep ListLayouts x

to :: Rep ListLayouts x -> ListLayouts

Read ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

readsPrec :: Int -> ReadS ListLayouts

readList :: ReadS [ListLayouts]

readPrec :: ReadPrec ListLayouts

readListPrec :: ReadPrec [ListLayouts]

Show ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

showsPrec :: Int -> ListLayouts -> ShowS

show :: ListLayouts -> String

showList :: [ListLayouts] -> ShowS

NFData ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

rnf :: ListLayouts -> ()

Eq ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

(==) :: ListLayouts -> ListLayouts -> Bool

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

Hashable ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

Methods

hashWithSalt :: Int -> ListLayouts -> Int

hash :: ListLayouts -> Int

type AWSResponse ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

type AWSResponse ListLayouts = ListLayoutsResponse

type Rep ListLayouts

Defined in Amazonka.ConnectCases.ListLayouts

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

newListLayouts

Arguments

:: Text

ListLayouts

-> ListLayouts

Create a value of ListLayouts 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:maxResults:ListLayouts', listLayouts_maxResults - The maximum number of results to return per page.

ListLayouts, listLayouts_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListLayouts, listLayouts_domainId - The unique identifier of the Cases domain.

Request Lenses

listLayouts_maxResults :: Lens' ListLayouts (Maybe Natural)

The maximum number of results to return per page.

listLayouts_nextToken :: Lens' ListLayouts (Maybe Text)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listLayouts_domainId :: Lens' ListLayouts Text

The unique identifier of the Cases domain.

Destructuring the Response

data ListLayoutsResponse

See: newListLayoutsResponse smart constructor.

Constructors

ListLayoutsResponse'

Fields

• nextToken :: Maybe Text

  The token for the next set of results. This is null if there are no more results to return.

• httpStatus :: Int

  The response's http status code.

• layouts :: [LayoutSummary]

  The layouts for the domain.

Instances

Generic ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

Associated Types

type Rep ListLayoutsResponse :: Type -> Type

Methods

from :: ListLayoutsResponse -> Rep ListLayoutsResponse x

to :: Rep ListLayoutsResponse x -> ListLayoutsResponse

Read ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

Methods

readsPrec :: Int -> ReadS ListLayoutsResponse

readList :: ReadS [ListLayoutsResponse]

readPrec :: ReadPrec ListLayoutsResponse

readListPrec :: ReadPrec [ListLayoutsResponse]

Show ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

Methods

showsPrec :: Int -> ListLayoutsResponse -> ShowS

show :: ListLayoutsResponse -> String

showList :: [ListLayoutsResponse] -> ShowS

NFData ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

Methods

rnf :: ListLayoutsResponse -> ()

Eq ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

Methods

(==) :: ListLayoutsResponse -> ListLayoutsResponse -> Bool

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

type Rep ListLayoutsResponse

Defined in Amazonka.ConnectCases.ListLayouts

type Rep ListLayoutsResponse = D1 ('MetaData "ListLayoutsResponse" "Amazonka.ConnectCases.ListLayouts" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "ListLayoutsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "layouts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [LayoutSummary]))))

newListLayoutsResponse

Arguments

:: Int

$sel:httpStatus:ListLayoutsResponse'

-> ListLayoutsResponse

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

ListLayouts, listLayoutsResponse_nextToken - The token for the next set of results. This is null if there are no more results to return.

$sel:httpStatus:ListLayoutsResponse', listLayoutsResponse_httpStatus - The response's http status code.

$sel:layouts:ListLayoutsResponse', listLayoutsResponse_layouts - The layouts for the domain.

Response Lenses

listLayoutsResponse_nextToken :: Lens' ListLayoutsResponse (Maybe Text)

The token for the next set of results. This is null if there are no more results to return.

listLayoutsResponse_httpStatus :: Lens' ListLayoutsResponse Int

The response's http status code.

listLayoutsResponse_layouts :: Lens' ListLayoutsResponse [LayoutSummary]

The layouts for the domain.