LexModelBuildingService
Service object for interacting with AWS LexModelBuildingService service.
public struct LexModelBuildingService: AWSService
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the LexModelBuildingService client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: LexModelBuildingService, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
createBotVersion(_:logger:on:)
public func createBotVersion(_ input: CreateBotVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateBotVersionResponse>
Creates a new version of the bot based on the $LATEST
version. If the $LATEST
version of this resource hasn't
changed since you created the last version, Amazon Lex doesn't create a new
version. It returns the last created version.
You can update only the $LATEST
version of the bot.
You can't update the numbered versions that you create with the
CreateBotVersion
operation.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permission for the
lex:CreateBotVersion
action.
createIntentVersion(_:logger:on:)
public func createIntentVersion(_ input: CreateIntentVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateIntentVersionResponse>
Creates a new version of an intent based on the
$LATEST
version of the intent. If the $LATEST
version of this intent hasn't changed since you last updated it, Amazon Lex
doesn't create a new version. It returns the last version you
created.
You can update only the $LATEST
version of the
intent. You can't update the numbered versions that you create with the
CreateIntentVersion
operation.
When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions to perform the
lex:CreateIntentVersion
action.
createSlotTypeVersion(_:logger:on:)
public func createSlotTypeVersion(_ input: CreateSlotTypeVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateSlotTypeVersionResponse>
Creates a new version of a slot type based on the
$LATEST
version of the specified slot type. If the
$LATEST
version of this resource has not changed since the
last version that you created, Amazon Lex doesn't create a new version. It
returns the last version that you created.
You can update only the $LATEST
version of a slot
type. You can't update the numbered versions that you create with the
CreateSlotTypeVersion
operation.
When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions for the
lex:CreateSlotTypeVersion
action.
deleteBot(_:logger:on:)
@discardableResult public func deleteBot(_ input: DeleteBotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes all versions of the bot, including the $LATEST
version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot
operation doesn't immediately remove the bot schema. Instead, it is marked
for deletion and removed later.
Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.
If a bot has an alias, you can't delete it. Instead, the
DeleteBot
operation returns a
ResourceInUseException
exception that includes a reference
to the alias that refers to the bot. To remove the reference to the bot,
delete the alias. If you get the same exception again, delete the
referring alias until the DeleteBot
operation is
successful.
This operation requires permissions for the
lex:DeleteBot
action.
deleteBotAlias(_:logger:on:)
@discardableResult public func deleteBotAlias(_ input: DeleteBotAliasRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a
bot and a messaging channel. If an alias is used in a channel association,
the DeleteBot
operation returns a
ResourceInUseException
exception that includes a reference
to the channel association that refers to the bot. You can remove the
reference to the alias by deleting the channel association. If you get the
same exception again, delete the referring association until the
DeleteBotAlias
operation is successful.
deleteBotChannelAssociation(_:logger:on:)
@discardableResult public func deleteBotChannelAssociation(_ input: DeleteBotChannelAssociationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the
lex:DeleteBotChannelAssociation
action.
deleteBotVersion(_:logger:on:)
@discardableResult public func deleteBotVersion(_ input: DeleteBotVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the
lex:DeleteBotVersion
action.
deleteIntent(_:logger:on:)
@discardableResult public func deleteIntent(_ input: DeleteIntentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes all versions of the intent, including the
$LATEST
version. To delete a specific version of the
intent, use the DeleteIntentVersion operation.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the ResourceInUseException
exception, it
provides an example reference that shows where the intent is referenced.
To remove the reference to the intent, either update the bot or delete
it. If you get the same exception when you attempt to delete the intent
again, repeat until the intent has no references and the call to
DeleteIntent
is successful.
This operation requires permission for the
lex:DeleteIntent
action.
deleteIntentVersion(_:logger:on:)
@discardableResult public func deleteIntentVersion(_ input: DeleteIntentVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the
lex:DeleteIntentVersion
action.
deleteSlotType(_:logger:on:)
@discardableResult public func deleteSlotType(_ input: DeleteSlotTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes all versions of the slot type, including the
$LATEST
version. To delete a specific version of the slot
type, use the DeleteSlotTypeVersion operation.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the ResourceInUseException
exception,
the exception provides an example reference that shows the intent where
the slot type is referenced. To remove the reference to the slot type,
either update the intent or delete it. If you get the same exception
when you attempt to delete the slot type again, repeat until the slot
type has no references and the DeleteSlotType
call is
successful.
This operation requires permission for the
lex:DeleteSlotType
action.
deleteSlotTypeVersion(_:logger:on:)
@discardableResult public func deleteSlotTypeVersion(_ input: DeleteSlotTypeVersionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the
lex:DeleteSlotTypeVersion
action.
deleteUtterances(_:logger:on:)
@discardableResult public func deleteUtterances(_ input: DeleteUtterancesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.
Use the DeleteUtterances
operation to manually delete
stored utterances for a specific user. When you use the
DeleteUtterances
operation, utterances stored for improving
your bot's ability to respond to user input are deleted immediately.
Utterances stored for use with the GetUtterancesView
operation are deleted after 15 days.
This operation requires permissions for the
lex:DeleteUtterances
action.
getBot(_:logger:on:)
public func getBot(_ input: GetBotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotResponse>
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the
lex:GetBot
action.
getBotAlias(_:logger:on:)
public func getBotAlias(_ input: GetBotAliasRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotAliasResponse>
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:GetBotAlias
action.
getBotAliases(_:logger:on:)
public func getBotAliases(_ input: GetBotAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotAliasesResponse>
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
lex:GetBotAliases
action.
getBotChannelAssociation(_:logger:on:)
public func getBotChannelAssociation(_ input: GetBotChannelAssociationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotChannelAssociationResponse>
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the
lex:GetBotChannelAssociation
action.
getBotChannelAssociations(_:logger:on:)
public func getBotChannelAssociations(_ input: GetBotChannelAssociationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotChannelAssociationsResponse>
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations
operation requires
permissions for the lex:GetBotChannelAssociations
action.
getBotVersions(_:logger:on:)
public func getBotVersions(_ input: GetBotVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotVersionsResponse>
Gets information about all of the versions of a bot.
The GetBotVersions
operation returns a
BotMetadata
object for each version of a bot. For example,
if a bot has three numbered versions, the GetBotVersions
operation returns four BotMetadata
objects in the response,
one for each numbered version and one for the $LATEST
version.
The GetBotVersions
operation always returns at least
one version, the $LATEST
version.
This operation requires permissions for the
lex:GetBotVersions
action.
getBots(_:logger:on:)
public func getBots(_ input: GetBotsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBotsResponse>
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for the$LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about the$LATEST
version of all of your bots.
This operation requires permission for the lex:GetBots
action.
getBuiltinIntent(_:logger:on:)
public func getBuiltinIntent(_ input: GetBuiltinIntentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBuiltinIntentResponse>
Returns information about a built-in intent.
This operation requires permission for the
lex:GetBuiltinIntent
action.
getBuiltinIntents(_:logger:on:)
public func getBuiltinIntents(_ input: GetBuiltinIntentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBuiltinIntentsResponse>
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
lex:GetBuiltinIntents
action.
getBuiltinSlotTypes(_:logger:on:)
public func getBuiltinSlotTypes(_ input: GetBuiltinSlotTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetBuiltinSlotTypesResponse>
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
lex:GetBuiltInSlotTypes
action.
getExport(_:logger:on:)
public func getExport(_ input: GetExportRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetExportResponse>
Exports the contents of a Amazon Lex resource in a specified format.
getImport(_:logger:on:)
public func getImport(_ input: GetImportRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetImportResponse>
Gets information about an import job started with the
StartImport
operation.
getIntent(_:logger:on:)
public func getIntent(_ input: GetIntentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetIntentResponse>
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the
lex:GetIntent
action.
getIntentVersions(_:logger:on:)
public func getIntentVersions(_ input: GetIntentVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetIntentVersionsResponse>
Gets information about all of the versions of an intent.
The GetIntentVersions
operation returns an
IntentMetadata
object for each version of an intent. For
example, if an intent has three numbered versions, the
GetIntentVersions
operation returns four
IntentMetadata
objects in the response, one for each
numbered version and one for the $LATEST
version.
The GetIntentVersions
operation always returns at
least one version, the $LATEST
version.
This operation requires permissions for the
lex:GetIntentVersions
action.
getIntents(_:logger:on:)
public func getIntents(_ input: GetIntentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetIntentsResponse>
Returns intent information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all intents.
The operation requires permission for the
lex:GetIntents
action.
getMigration(_:logger:on:)
public func getMigration(_ input: GetMigrationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetMigrationResponse>
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
getMigrations(_:logger:on:)
public func getMigrations(_ input: GetMigrationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetMigrationsResponse>
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
getSlotType(_:logger:on:)
public func getSlotType(_ input: GetSlotTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSlotTypeResponse>
Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the
lex:GetSlotType
action.
getSlotTypeVersions(_:logger:on:)
public func getSlotTypeVersions(_ input: GetSlotTypeVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSlotTypeVersionsResponse>
Gets information about all versions of a slot type.
The GetSlotTypeVersions
operation returns a
SlotTypeMetadata
object for each version of a slot type.
For example, if a slot type has three numbered versions, the
GetSlotTypeVersions
operation returns four
SlotTypeMetadata
objects in the response, one for each
numbered version and one for the $LATEST
version.
The GetSlotTypeVersions
operation always returns at
least one version, the $LATEST
version.
This operation requires permissions for the
lex:GetSlotTypeVersions
action.
getSlotTypes(_:logger:on:)
public func getSlotTypes(_ input: GetSlotTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetSlotTypesResponse>
Returns slot type information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all slot types.
The operation requires permission for the
lex:GetSlotTypes
action.
getUtterancesView(_:logger:on:)
public func getUtterancesView(_ input: GetUtterancesViewRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetUtterancesViewResponse>
Use the GetUtterancesView
operation to get information
about the utterances that your users have made to your bot. You can use
this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers.
After your users have used your bot for a while, use the
GetUtterancesView
operation to see the requests that they
have made and whether they have been successful. You might find that the
utterance "I want flowers" is not being recognized. You could add this
utterance to the OrderFlowers
intent so that your bot
recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set childDirected
field to true when you
created your bot, if you are using slot obfuscation with one or more
slots, or if you opted out of participating in improving Amazon Lex, utterances
are not available.
This operation requires permissions for the
lex:GetUtterancesView
action.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
putBot(_:logger:on:)
public func putBot(_ input: PutBotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutBotResponse>
Creates an Amazon Lex conversational bot or replaces an existing bot.
When you create or update a bot you are only required to specify a name, a
locale, and whether the bot is directed toward children under age 13. You
can use this to add intents later, or to remove intents from an existing
bot. When you create a bot with the minimum information, the bot is
created or updated but Amazon Lex returns the response
FAILED
. You can build the bot after you add one or more
intents. For more information about Amazon Lex bots, see how-it-works.
If you specify the name of an existing bot, the fields in the
request replace the existing values in the $LATEST
version of
the bot. Amazon Lex removes any fields that you don't provide values for in the
request, except for the idleTTLInSeconds
and
privacySettings
fields, which are set to their default
values. If you don't specify values for required fields, Amazon Lex throws an
exception.
This operation requires permissions for the lex:PutBot
action. For more information, see security-iam.
putBotAlias(_:logger:on:)
public func putBotAlias(_ input: PutBotAliasRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutBotAliasResponse>
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the
lex:PutBotAlias
action.
putIntent(_:logger:on:)
public func putIntent(_ input: PutIntentRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutIntentResponse>
Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use
one or more intents. For a pizza ordering bot, for example, you would
create an OrderPizza
intent.
To create an intent or replace an existing intent, you must provide the following:
-
Intent name. For example,
OrderPizza
. -
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
-
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
-
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
-
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
-
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex
replaces the values in the $LATEST
version of the intent with
the values in the request. Amazon Lex removes fields that you don't provide in
the request. If you don't specify the required fields, Amazon Lex throws an
exception. When you update the $LATEST
version of an intent,
the status
field of any bot that uses the
$LATEST
version of the intent is set to
NOT_BUILT
.
For more information, see how-it-works.
This operation requires permissions for the
lex:PutIntent
action.
putSlotType(_:logger:on:)
public func putSlotType(_ input: PutSlotTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutSlotTypeResponse>
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the
request replace the existing values in the $LATEST
version of
the slot type. Amazon Lex removes the fields that you don't provide in the
request. If you don't specify required fields, Amazon Lex throws an exception.
When you update the $LATEST
version of a slot type, if a bot
uses the $LATEST
version of an intent that contains the slot
type, the bot's status
field is set to
NOT_BUILT
.
This operation requires permissions for the
lex:PutSlotType
action.
startImport(_:logger:on:)
public func startImport(_ input: StartImportRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartImportResponse>
Starts a job to import a resource to Amazon Lex.
startMigration(_:logger:on:)
public func startMigration(_ input: StartMigrationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartMigrationResponse>
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex developer guide.
tagResource(_:logger:on:)
public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResponse>
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
untagResource(_:logger:on:)
public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResponse>
Removes tags from a bot, bot alias or bot channel.
getBotAliasesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBotAliasesPaginator( _ input: GetBotAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBotAliasesRequest, GetBotAliasesResponse>
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetBotAliases
action.
getBotChannelAssociationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBotChannelAssociationsPaginator( _ input: GetBotChannelAssociationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBotChannelAssociationsRequest, GetBotChannelAssociationsResponse>
Returns a list of all of the channels associated with the specified bot.
The
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onGetBotChannelAssociations
operation requires permissions for thelex:GetBotChannelAssociations
action.
getBotVersionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBotVersionsPaginator( _ input: GetBotVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBotVersionsRequest, GetBotVersionsResponse>
Gets information about all of the versions of a bot.
The
GetBotVersions
operation returns aBotMetadata
object for each version of a bot. For example, if a bot has three numbered versions, theGetBotVersions
operation returns fourBotMetadata
objects in the response, one for each numbered version and one for the$LATEST
version.The
GetBotVersions
operation always returns at least one version, the$LATEST
version.This operation requires permissions for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetBotVersions
action.
getBotsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBotsPaginator( _ input: GetBotsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBotsRequest, GetBotsResponse>
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for the$LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about the$LATEST
version of all of your bots.
This operation requires permission for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetBots
action.-
getBuiltinIntentsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBuiltinIntentsPaginator( _ input: GetBuiltinIntentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBuiltinIntentsRequest, GetBuiltinIntentsResponse>
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetBuiltinIntents
action.
getBuiltinSlotTypesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getBuiltinSlotTypesPaginator( _ input: GetBuiltinSlotTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetBuiltinSlotTypesRequest, GetBuiltinSlotTypesResponse>
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetBuiltInSlotTypes
action.
getIntentVersionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getIntentVersionsPaginator( _ input: GetIntentVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetIntentVersionsRequest, GetIntentVersionsResponse>
Gets information about all of the versions of an intent.
The
GetIntentVersions
operation returns anIntentMetadata
object for each version of an intent. For example, if an intent has three numbered versions, theGetIntentVersions
operation returns fourIntentMetadata
objects in the response, one for each numbered version and one for the$LATEST
version.The
GetIntentVersions
operation always returns at least one version, the$LATEST
version.This operation requires permissions for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetIntentVersions
action.
getIntentsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getIntentsPaginator( _ input: GetIntentsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetIntentsRequest, GetIntentsResponse>
Returns intent information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all intents.
The operation requires permission for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetIntents
action.-
getMigrationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getMigrationsPaginator( _ input: GetMigrationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetMigrationsRequest, GetMigrationsResponse>
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getSlotTypeVersionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getSlotTypeVersionsPaginator( _ input: GetSlotTypeVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetSlotTypeVersionsRequest, GetSlotTypeVersionsResponse>
Gets information about all versions of a slot type.
The
GetSlotTypeVersions
operation returns aSlotTypeMetadata
object for each version of a slot type. For example, if a slot type has three numbered versions, theGetSlotTypeVersions
operation returns fourSlotTypeMetadata
objects in the response, one for each numbered version and one for the$LATEST
version.The
GetSlotTypeVersions
operation always returns at least one version, the$LATEST
version.This operation requires permissions for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetSlotTypeVersions
action.
getSlotTypesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getSlotTypesPaginator( _ input: GetSlotTypesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetSlotTypesRequest, GetSlotTypesResponse>
Returns slot type information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all slot types.
The operation requires permission for the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlex:GetSlotTypes
action.-
getBotAliasesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBotAliasesPaginator<Result>(
_ input: GetBotAliasesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBotAliasesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
lex:GetBotAliases
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBotAliasesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBotAliasesPaginator(
_ input: GetBotAliasesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBotAliasesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getBotChannelAssociationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBotChannelAssociationsPaginator<Result>(
_ input: GetBotChannelAssociationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBotChannelAssociationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations
operation requires
permissions for the lex:GetBotChannelAssociations
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBotChannelAssociationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBotChannelAssociationsPaginator(
_ input: GetBotChannelAssociationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBotChannelAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getBotVersionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBotVersionsPaginator<Result>(
_ input: GetBotVersionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBotVersionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets information about all of the versions of a bot.
The GetBotVersions
operation returns a
BotMetadata
object for each version of a bot. For example,
if a bot has three numbered versions, the GetBotVersions
operation returns four BotMetadata
objects in the response,
one for each numbered version and one for the $LATEST
version.
The GetBotVersions
operation always returns at least
one version, the $LATEST
version.
This operation requires permissions for the
lex:GetBotVersions
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBotVersionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBotVersionsPaginator(
_ input: GetBotVersionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBotVersionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getBotsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBotsPaginator<Result>(
_ input: GetBotsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBotsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns bot information as follows:
-
If you provide the
nameContains
field, the response includes information for the$LATEST
version of all bots whose name contains the specified string. -
If you don't specify the
nameContains
field, the operation returns information about the$LATEST
version of all of your bots.
This operation requires permission for the lex:GetBots
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBotsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBotsPaginator(
_ input: GetBotsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBotsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getBuiltinIntentsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBuiltinIntentsPaginator<Result>(
_ input: GetBuiltinIntentsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBuiltinIntentsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the
lex:GetBuiltinIntents
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBuiltinIntentsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBuiltinIntentsPaginator(
_ input: GetBuiltinIntentsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBuiltinIntentsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getBuiltinSlotTypesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getBuiltinSlotTypesPaginator<Result>(
_ input: GetBuiltinSlotTypesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetBuiltinSlotTypesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the
lex:GetBuiltInSlotTypes
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getBuiltinSlotTypesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getBuiltinSlotTypesPaginator(
_ input: GetBuiltinSlotTypesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetBuiltinSlotTypesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getIntentVersionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getIntentVersionsPaginator<Result>(
_ input: GetIntentVersionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetIntentVersionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets information about all of the versions of an intent.
The GetIntentVersions
operation returns an
IntentMetadata
object for each version of an intent. For
example, if an intent has three numbered versions, the
GetIntentVersions
operation returns four
IntentMetadata
objects in the response, one for each
numbered version and one for the $LATEST
version.
The GetIntentVersions
operation always returns at
least one version, the $LATEST
version.
This operation requires permissions for the
lex:GetIntentVersions
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getIntentVersionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getIntentVersionsPaginator(
_ input: GetIntentVersionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetIntentVersionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getIntentsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getIntentsPaginator<Result>(
_ input: GetIntentsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetIntentsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns intent information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all intents that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all intents.
The operation requires permission for the
lex:GetIntents
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getIntentsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getIntentsPaginator(
_ input: GetIntentsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetIntentsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getMigrationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getMigrationsPaginator<Result>(
_ input: GetMigrationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetMigrationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getMigrationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getMigrationsPaginator(
_ input: GetMigrationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetMigrationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getSlotTypeVersionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getSlotTypeVersionsPaginator<Result>(
_ input: GetSlotTypeVersionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetSlotTypeVersionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Gets information about all versions of a slot type.
The GetSlotTypeVersions
operation returns a
SlotTypeMetadata
object for each version of a slot type.
For example, if a slot type has three numbered versions, the
GetSlotTypeVersions
operation returns four
SlotTypeMetadata
objects in the response, one for each
numbered version and one for the $LATEST
version.
The GetSlotTypeVersions
operation always returns at
least one version, the $LATEST
version.
This operation requires permissions for the
lex:GetSlotTypeVersions
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getSlotTypeVersionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getSlotTypeVersionsPaginator(
_ input: GetSlotTypeVersionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetSlotTypeVersionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
getSlotTypesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func getSlotTypesPaginator<Result>(
_ input: GetSlotTypesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetSlotTypesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns slot type information as follows:
-
If you specify the
nameContains
field, returns the$LATEST
version of all slot types that contain the specified string. -
If you don't specify the
nameContains
field, returns information about the$LATEST
version of all slot types.
The operation requires permission for the
lex:GetSlotTypes
action.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
getSlotTypesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func getSlotTypesPaginator(
_ input: GetSlotTypesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetSlotTypesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.