Amazonka.LexModels.GetBotChannelAssociations

Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

This operation returns paginated results.

Creating a Request

data GetBotChannelAssociations

See: newGetBotChannelAssociations smart constructor.

Constructors

GetBotChannelAssociations'

Fields

• maxResults :: Maybe Natural

  The maximum number of associations to return in the response. The default is 50.

• nameContains :: Maybe Text

  Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

• nextToken :: Maybe Text

  A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

• botName :: Text

  The name of the Amazon Lex bot in the association.

• botAlias :: Text

  An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Instances

ToHeaders GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

toHeaders :: GetBotChannelAssociations -> [Header]

ToPath GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

toPath :: GetBotChannelAssociations -> ByteString

ToQuery GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

toQuery :: GetBotChannelAssociations -> QueryString

AWSPager GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

page :: GetBotChannelAssociations -> AWSResponse GetBotChannelAssociations -> Maybe GetBotChannelAssociations

AWSRequest GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Associated Types

type AWSResponse GetBotChannelAssociations

Methods

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

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

Generic GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Associated Types

type Rep GetBotChannelAssociations :: Type -> Type

Methods

from :: GetBotChannelAssociations -> Rep GetBotChannelAssociations x

to :: Rep GetBotChannelAssociations x -> GetBotChannelAssociations

Read GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

readsPrec :: Int -> ReadS GetBotChannelAssociations

readList :: ReadS [GetBotChannelAssociations]

readPrec :: ReadPrec GetBotChannelAssociations

readListPrec :: ReadPrec [GetBotChannelAssociations]

Show GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

showsPrec :: Int -> GetBotChannelAssociations -> ShowS

show :: GetBotChannelAssociations -> String

showList :: [GetBotChannelAssociations] -> ShowS

NFData GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

rnf :: GetBotChannelAssociations -> ()

Eq GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

(==) :: GetBotChannelAssociations -> GetBotChannelAssociations -> Bool

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

Hashable GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

hashWithSalt :: Int -> GetBotChannelAssociations -> Int

hash :: GetBotChannelAssociations -> Int

type AWSResponse GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

type AWSResponse GetBotChannelAssociations = GetBotChannelAssociationsResponse

type Rep GetBotChannelAssociations

Defined in Amazonka.LexModels.GetBotChannelAssociations

type Rep GetBotChannelAssociations = D1 ('MetaData "GetBotChannelAssociations" "Amazonka.LexModels.GetBotChannelAssociations" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotChannelAssociations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "botAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetBotChannelAssociations

Arguments

:: Text

GetBotChannelAssociations

-> Text

GetBotChannelAssociations

-> GetBotChannelAssociations

Create a value of GetBotChannelAssociations 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:GetBotChannelAssociations', getBotChannelAssociations_maxResults - The maximum number of associations to return in the response. The default is 50.

$sel:nameContains:GetBotChannelAssociations', getBotChannelAssociations_nameContains - Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

GetBotChannelAssociations, getBotChannelAssociations_nextToken - A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

GetBotChannelAssociations, getBotChannelAssociations_botName - The name of the Amazon Lex bot in the association.

GetBotChannelAssociations, getBotChannelAssociations_botAlias - An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Request Lenses

getBotChannelAssociations_maxResults :: Lens' GetBotChannelAssociations (Maybe Natural)

The maximum number of associations to return in the response. The default is 50.

getBotChannelAssociations_nameContains :: Lens' GetBotChannelAssociations (Maybe Text)

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

getBotChannelAssociations_nextToken :: Lens' GetBotChannelAssociations (Maybe Text)

A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

getBotChannelAssociations_botName :: Lens' GetBotChannelAssociations Text

The name of the Amazon Lex bot in the association.

getBotChannelAssociations_botAlias :: Lens' GetBotChannelAssociations Text

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Destructuring the Response

data GetBotChannelAssociationsResponse

See: newGetBotChannelAssociationsResponse smart constructor.

Constructors

GetBotChannelAssociationsResponse'

Fields

• botChannelAssociations :: Maybe [BotChannelAssociation]

  An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.

• nextToken :: Maybe Text

  A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBotChannelAssociationsResponse

Defined in Amazonka.LexModels.GetBotChannelAssociations

Associated Types

type Rep GetBotChannelAssociationsResponse :: Type -> Type

Methods

from :: GetBotChannelAssociationsResponse -> Rep GetBotChannelAssociationsResponse x

to :: Rep GetBotChannelAssociationsResponse x -> GetBotChannelAssociationsResponse

Show GetBotChannelAssociationsResponse

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

showsPrec :: Int -> GetBotChannelAssociationsResponse -> ShowS

show :: GetBotChannelAssociationsResponse -> String

showList :: [GetBotChannelAssociationsResponse] -> ShowS

NFData GetBotChannelAssociationsResponse

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

rnf :: GetBotChannelAssociationsResponse -> ()

Eq GetBotChannelAssociationsResponse

Defined in Amazonka.LexModels.GetBotChannelAssociations

Methods

(==) :: GetBotChannelAssociationsResponse -> GetBotChannelAssociationsResponse -> Bool

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

type Rep GetBotChannelAssociationsResponse

Defined in Amazonka.LexModels.GetBotChannelAssociations

type Rep GetBotChannelAssociationsResponse = D1 ('MetaData "GetBotChannelAssociationsResponse" "Amazonka.LexModels.GetBotChannelAssociations" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBotChannelAssociationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "botChannelAssociations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotChannelAssociation])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBotChannelAssociationsResponse

Arguments

:: Int

$sel:httpStatus:GetBotChannelAssociationsResponse'

-> GetBotChannelAssociationsResponse

Create a value of GetBotChannelAssociationsResponse 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:botChannelAssociations:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_botChannelAssociations - An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.

GetBotChannelAssociations, getBotChannelAssociationsResponse_nextToken - A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

$sel:httpStatus:GetBotChannelAssociationsResponse', getBotChannelAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

getBotChannelAssociationsResponse_botChannelAssociations :: Lens' GetBotChannelAssociationsResponse (Maybe [BotChannelAssociation])

An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.

getBotChannelAssociationsResponse_nextToken :: Lens' GetBotChannelAssociationsResponse (Maybe Text)

A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

getBotChannelAssociationsResponse_httpStatus :: Lens' GetBotChannelAssociationsResponse Int

The response's http status code.