Amazonka.LexV2Models.ListBuiltInIntents

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

Creating a Request

data ListBuiltInIntents

See: newListBuiltInIntents smart constructor.

Constructors

ListBuiltInIntents'

Fields

• maxResults :: Maybe Natural

  The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

• nextToken :: Maybe Text

  If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

• sortBy :: Maybe BuiltInIntentSortBy

  Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

• localeId :: Text

  The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Instances

ToJSON ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

toJSON :: ListBuiltInIntents -> Value

toEncoding :: ListBuiltInIntents -> Encoding

toJSONList :: [ListBuiltInIntents] -> Value

toEncodingList :: [ListBuiltInIntents] -> Encoding

ToHeaders ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

toHeaders :: ListBuiltInIntents -> [Header]

ToPath ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

toPath :: ListBuiltInIntents -> ByteString

ToQuery ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

toQuery :: ListBuiltInIntents -> QueryString

AWSRequest ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Associated Types

type AWSResponse ListBuiltInIntents

Methods

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

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

Generic ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Associated Types

type Rep ListBuiltInIntents :: Type -> Type

Methods

from :: ListBuiltInIntents -> Rep ListBuiltInIntents x

to :: Rep ListBuiltInIntents x -> ListBuiltInIntents

Read ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

readsPrec :: Int -> ReadS ListBuiltInIntents

readList :: ReadS [ListBuiltInIntents]

readPrec :: ReadPrec ListBuiltInIntents

readListPrec :: ReadPrec [ListBuiltInIntents]

Show ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

showsPrec :: Int -> ListBuiltInIntents -> ShowS

show :: ListBuiltInIntents -> String

showList :: [ListBuiltInIntents] -> ShowS

NFData ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

rnf :: ListBuiltInIntents -> ()

Eq ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

(==) :: ListBuiltInIntents -> ListBuiltInIntents -> Bool

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

Hashable ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

hashWithSalt :: Int -> ListBuiltInIntents -> Int

hash :: ListBuiltInIntents -> Int

type AWSResponse ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

type AWSResponse ListBuiltInIntents = ListBuiltInIntentsResponse

type Rep ListBuiltInIntents

Defined in Amazonka.LexV2Models.ListBuiltInIntents

type Rep ListBuiltInIntents = D1 ('MetaData "ListBuiltInIntents" "Amazonka.LexV2Models.ListBuiltInIntents" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBuiltInIntents'" '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 "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BuiltInIntentSortBy)) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListBuiltInIntents

Arguments

:: Text

ListBuiltInIntents

-> ListBuiltInIntents

Create a value of ListBuiltInIntents 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:ListBuiltInIntents', listBuiltInIntents_maxResults - The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

ListBuiltInIntents, listBuiltInIntents_nextToken - If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

$sel:sortBy:ListBuiltInIntents', listBuiltInIntents_sortBy - Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

ListBuiltInIntents, listBuiltInIntents_localeId - The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Request Lenses

listBuiltInIntents_maxResults :: Lens' ListBuiltInIntents (Maybe Natural)

The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

listBuiltInIntents_nextToken :: Lens' ListBuiltInIntents (Maybe Text)

If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

listBuiltInIntents_sortBy :: Lens' ListBuiltInIntents (Maybe BuiltInIntentSortBy)

Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

listBuiltInIntents_localeId :: Lens' ListBuiltInIntents Text

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Destructuring the Response

data ListBuiltInIntentsResponse

See: newListBuiltInIntentsResponse smart constructor.

Constructors

ListBuiltInIntentsResponse'

Fields

• builtInIntentSummaries :: Maybe [BuiltInIntentSummary]

  Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

• localeId :: Maybe Text

  The language and locale of the intents in the list.

• nextToken :: Maybe Text

  A token that indicates whether there are more results to return in a response to the ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Associated Types

type Rep ListBuiltInIntentsResponse :: Type -> Type

Methods

from :: ListBuiltInIntentsResponse -> Rep ListBuiltInIntentsResponse x

to :: Rep ListBuiltInIntentsResponse x -> ListBuiltInIntentsResponse

Read ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

readsPrec :: Int -> ReadS ListBuiltInIntentsResponse

readList :: ReadS [ListBuiltInIntentsResponse]

readPrec :: ReadPrec ListBuiltInIntentsResponse

readListPrec :: ReadPrec [ListBuiltInIntentsResponse]

Show ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

showsPrec :: Int -> ListBuiltInIntentsResponse -> ShowS

show :: ListBuiltInIntentsResponse -> String

showList :: [ListBuiltInIntentsResponse] -> ShowS

NFData ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

rnf :: ListBuiltInIntentsResponse -> ()

Eq ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

Methods

(==) :: ListBuiltInIntentsResponse -> ListBuiltInIntentsResponse -> Bool

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

type Rep ListBuiltInIntentsResponse

Defined in Amazonka.LexV2Models.ListBuiltInIntents

type Rep ListBuiltInIntentsResponse = D1 ('MetaData "ListBuiltInIntentsResponse" "Amazonka.LexV2Models.ListBuiltInIntents" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBuiltInIntentsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "builtInIntentSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BuiltInIntentSummary])) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBuiltInIntentsResponse

Arguments

:: Int

$sel:httpStatus:ListBuiltInIntentsResponse'

-> ListBuiltInIntentsResponse

Create a value of ListBuiltInIntentsResponse 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:builtInIntentSummaries:ListBuiltInIntentsResponse', listBuiltInIntentsResponse_builtInIntentSummaries - Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

ListBuiltInIntents, listBuiltInIntentsResponse_localeId - The language and locale of the intents in the list.

ListBuiltInIntents, listBuiltInIntentsResponse_nextToken - A token that indicates whether there are more results to return in a response to the ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

$sel:httpStatus:ListBuiltInIntentsResponse', listBuiltInIntentsResponse_httpStatus - The response's http status code.

Response Lenses

listBuiltInIntentsResponse_builtInIntentSummaries :: Lens' ListBuiltInIntentsResponse (Maybe [BuiltInIntentSummary])

Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

listBuiltInIntentsResponse_localeId :: Lens' ListBuiltInIntentsResponse (Maybe Text)

The language and locale of the intents in the list.

listBuiltInIntentsResponse_nextToken :: Lens' ListBuiltInIntentsResponse (Maybe Text)

A token that indicates whether there are more results to return in a response to the ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

listBuiltInIntentsResponse_httpStatus :: Lens' ListBuiltInIntentsResponse Int

The response's http status code.