Amazonka.Connect.ListUseCases

Lists the use cases for the integration association.

This operation returns paginated results.

Creating a Request

data ListUseCases

Provides summary information about the use cases for the specified integration association.

See: newListUseCases smart constructor.

Constructors

ListUseCases'

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.

• instanceId :: Text

  The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

• integrationAssociationId :: Text

  The identifier for the integration association.

Instances

ToHeaders ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

toHeaders :: ListUseCases -> [Header]

ToPath ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

toPath :: ListUseCases -> ByteString

ToQuery ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

toQuery :: ListUseCases -> QueryString

AWSPager ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

page :: ListUseCases -> AWSResponse ListUseCases -> Maybe ListUseCases

AWSRequest ListUseCases

Defined in Amazonka.Connect.ListUseCases

Associated Types

type AWSResponse ListUseCases

Methods

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

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

Generic ListUseCases

Defined in Amazonka.Connect.ListUseCases

Associated Types

type Rep ListUseCases :: Type -> Type

Methods

from :: ListUseCases -> Rep ListUseCases x

to :: Rep ListUseCases x -> ListUseCases

Read ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

readsPrec :: Int -> ReadS ListUseCases

readList :: ReadS [ListUseCases]

readPrec :: ReadPrec ListUseCases

readListPrec :: ReadPrec [ListUseCases]

Show ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

showsPrec :: Int -> ListUseCases -> ShowS

show :: ListUseCases -> String

showList :: [ListUseCases] -> ShowS

NFData ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

rnf :: ListUseCases -> ()

Eq ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

(==) :: ListUseCases -> ListUseCases -> Bool

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

Hashable ListUseCases

Defined in Amazonka.Connect.ListUseCases

Methods

hashWithSalt :: Int -> ListUseCases -> Int

hash :: ListUseCases -> Int

type AWSResponse ListUseCases

Defined in Amazonka.Connect.ListUseCases

type AWSResponse ListUseCases = ListUseCasesResponse

type Rep ListUseCases

Defined in Amazonka.Connect.ListUseCases

type Rep ListUseCases = D1 ('MetaData "ListUseCases" "Amazonka.Connect.ListUseCases" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListUseCases'" '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 "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "integrationAssociationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListUseCases

Arguments

:: Text

ListUseCases

-> Text

ListUseCases

-> ListUseCases

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

ListUseCases, listUseCases_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.

ListUseCases, listUseCases_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ListUseCases, listUseCases_integrationAssociationId - The identifier for the integration association.

Request Lenses

listUseCases_maxResults :: Lens' ListUseCases (Maybe Natural)

The maximum number of results to return per page.

listUseCases_nextToken :: Lens' ListUseCases (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.

listUseCases_instanceId :: Lens' ListUseCases Text

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

listUseCases_integrationAssociationId :: Lens' ListUseCases Text

The identifier for the integration association.

Destructuring the Response

data ListUseCasesResponse

See: newListUseCasesResponse smart constructor.

Constructors

ListUseCasesResponse'

Fields

• nextToken :: Maybe Text

  If there are additional results, this is the token for the next set of results.

• useCaseSummaryList :: Maybe [UseCase]

  The use cases.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

Associated Types

type Rep ListUseCasesResponse :: Type -> Type

Methods

from :: ListUseCasesResponse -> Rep ListUseCasesResponse x

to :: Rep ListUseCasesResponse x -> ListUseCasesResponse

Read ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

Methods

readsPrec :: Int -> ReadS ListUseCasesResponse

readList :: ReadS [ListUseCasesResponse]

readPrec :: ReadPrec ListUseCasesResponse

readListPrec :: ReadPrec [ListUseCasesResponse]

Show ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

Methods

showsPrec :: Int -> ListUseCasesResponse -> ShowS

show :: ListUseCasesResponse -> String

showList :: [ListUseCasesResponse] -> ShowS

NFData ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

Methods

rnf :: ListUseCasesResponse -> ()

Eq ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

Methods

(==) :: ListUseCasesResponse -> ListUseCasesResponse -> Bool

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

type Rep ListUseCasesResponse

Defined in Amazonka.Connect.ListUseCases

type Rep ListUseCasesResponse = D1 ('MetaData "ListUseCasesResponse" "Amazonka.Connect.ListUseCases" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListUseCasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "useCaseSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UseCase])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUseCasesResponse

Arguments

:: Int

$sel:httpStatus:ListUseCasesResponse'

-> ListUseCasesResponse

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

ListUseCases, listUseCasesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:useCaseSummaryList:ListUseCasesResponse', listUseCasesResponse_useCaseSummaryList - The use cases.

$sel:httpStatus:ListUseCasesResponse', listUseCasesResponse_httpStatus - The response's http status code.

Response Lenses

listUseCasesResponse_nextToken :: Lens' ListUseCasesResponse (Maybe Text)

If there are additional results, this is the token for the next set of results.

listUseCasesResponse_useCaseSummaryList :: Lens' ListUseCasesResponse (Maybe [UseCase])

The use cases.

listUseCasesResponse_httpStatus :: Lens' ListUseCasesResponse Int

The response's http status code.