The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The details of a user or bot.
" }, + "InvokedBy":{ + "type":"structure", + "required":[ + "StandardMessages", + "TargetedMessages" + ], + "members":{ + "StandardMessages":{ + "shape":"StandardMessages", + "documentation":"Sets standard messages as the bot trigger. For standard messages:
ALL: The bot processes all standard messages.
AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.
MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.
NONE: The bot processes no standard messages.
Sets targeted messages as the bot trigger. For targeted messages:
ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.
NONE: The bot processes no targeted messages.
Specifies the type of message that triggers a bot.
" + }, "LexBotAliasArn":{ "type":"string", "max":2048, @@ -1450,14 +1468,17 @@ "LexConfiguration":{ "type":"structure", "required":[ - "RespondsTo", "LexBotAliasArn", "LocaleId" ], "members":{ "RespondsTo":{ "shape":"RespondsTo", - "documentation":"Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
" + "documentation":" Deprecated. Use InvokedBy instead.
Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
" + }, + "InvokedBy":{ + "shape":"InvokedBy", + "documentation":"Specifies the type of message that triggers a bot.
" }, "LexBotAliasArn":{ "shape":"LexBotAliasArn", @@ -1842,11 +1863,11 @@ "type":"structure", "members":{ "AppInstanceUserArn":{ - "shape":"SensitiveChimeArn", + "shape":"ChimeArn", "documentation":"The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The metadata of the AppInstanceBot.
The configuration for the bot update.
" } } }, @@ -2092,13 +2138,13 @@ ], "members":{ "AppInstanceUserArn":{ - "shape":"SensitiveChimeArn", + "shape":"ChimeArn", "documentation":"The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
Update message content or metadata
Deny a message
Make no changes to the message
Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
Update message content or metadata
Deny a message
Make no changes to the message
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide.
Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
New and updated messages
Persistent and non-persistent messages
The Standard message type
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message types in the Amazon Chime developer guide.
Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership to be able to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
Message processed successfully
Ongoing processing
Processing failed
Messasge denied by the processor
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
Message processed successfully
Ongoing processing
Processing failed
Message denied by the processor
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Sets the membership preferences of an AppInstanceUser or AppIntanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users or users. Banned users or bots can't set membership preferences for the channel from which they are banned.
The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.
The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
The message content.
" + "documentation":"The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "Metadata":{ "shape":"Metadata", @@ -1533,7 +1533,7 @@ }, "MessageAttributes":{ "shape":"MessageAttributeMap", - "documentation":"The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "SubChannelId":{ "shape":"SubChannelId", @@ -1541,7 +1541,11 @@ }, "ContentType":{ "shape":"ContentType", - "documentation":"The content type of the channel message.
" + "documentation":"The content type of the channel message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
" } }, "documentation":"The details of a message in a channel.
" @@ -1556,7 +1560,7 @@ }, "Content":{ "shape":"NonEmptyContent", - "documentation":"The message content.
" + "documentation":"The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "Metadata":{ "shape":"Metadata", @@ -1568,7 +1572,7 @@ }, "MessageAttributes":{ "shape":"MessageAttributeMap", - "documentation":"The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "SubChannelId":{ "shape":"SubChannelId", @@ -1576,7 +1580,7 @@ }, "ContentType":{ "shape":"ContentType", - "documentation":"The content type of the call-back message.
" + "documentation":"The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
Stores information about a callback.
" @@ -1606,7 +1610,7 @@ }, "Detail":{ "shape":"StatusDetail", - "documentation":"Contains more details about the messasge status.
" + "documentation":"Contains more details about the message status.
" } }, "documentation":"Stores information about a message status.
" @@ -1620,7 +1624,7 @@ }, "Content":{ "shape":"Content", - "documentation":"The content of the message.
" + "documentation":"The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "Metadata":{ "shape":"Metadata", @@ -1656,11 +1660,15 @@ }, "MessageAttributes":{ "shape":"MessageAttributeMap", - "documentation":"The message attribues listed in a the summary of a channel message.
" + "documentation":"The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
" }, "ContentType":{ "shape":"ContentType", - "documentation":"The content type of the channel messsage listed in the summary.
" + "documentation":"The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is application/amz-chime-lex-msgs for success responses and application/amz-chime-lex-error for failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
" } }, "documentation":"Summary of the messages in a Channel.
The time at which the last persistent message in a channel was sent.
" + "documentation":"The time at which the last persistent message visible to the caller in a channel was sent.
" } }, "documentation":"Summary of the details of a Channel.
The content of the message.
" + "documentation":"The content of the channel message.
" }, "Type":{ "shape":"ChannelMessageType", - "documentation":"The type of message, STANDARD or CONTROL.
The type of message, STANDARD or CONTROL.
STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.
CONTROL messages are limited to 30 bytes and do not contain metadata.
The content type of the channel message.
" + }, + "Target":{ + "shape":"TargetList", + "documentation":"The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
" } } }, @@ -4045,6 +4057,22 @@ "min":1, "sensitive":true }, + "Target":{ + "type":"structure", + "members":{ + "MemberArn":{ + "shape":"ChimeArn", + "documentation":"The ARN of the target channel member.
" + } + }, + "documentation":"The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
" + }, + "TargetList":{ + "type":"list", + "member":{"shape":"Target"}, + "max":1, + "min":1 + }, "TargetMembershipsPerSubChannel":{ "type":"integer", "min":2 @@ -4143,7 +4171,7 @@ }, "Content":{ "shape":"NonEmptyContent", - "documentation":"The content of the message being updated.
" + "documentation":"The content of the channel message.
" }, "Metadata":{ "shape":"Metadata", @@ -4263,5 +4291,5 @@ "max":4096 } }, - "documentation":"The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
" + "documentation":"The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
" } diff --git a/botocore/data/kendra/2019-02-03/service-2.json b/botocore/data/kendra/2019-02-03/service-2.json index 74d8fd7070..429a73cc0f 100644 --- a/botocore/data/kendra/2019-02-03/service-2.json +++ b/botocore/data/kendra/2019-02-03/service-2.json @@ -926,7 +926,26 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], - "documentation":"Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeFilter parameter.
Each query returns the 100 most relevant results.
" + "documentation":"Searches an index given an input query.
You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.
Retrieves relevant passages or text excerpts given an input query.
This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce no relevant passages using the Retrieve API, you can alternatively use the Query API.
You can also do the following:
Override boosting at the index level
Filter based on document fields or attributes
Filter based on the user or their group access to documents
You can also include certain fields in the response that might provide useful additional information.
" }, "StartDataSourceSyncJob":{ "name":"StartDataSourceSyncJob", @@ -1315,7 +1334,7 @@ "documentation":"Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
" } }, - "documentation":"Provides the configuration information to connect to Alfresco as your data source.
Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support.
Provides the configuration information to connect to Alfresco as your data source.
Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration API.
Provides the configuration information that's required to connect to a database.
" }, + "Content":{"type":"string"}, "ContentSourceConfiguration":{ "type":"structure", "members":{ @@ -2562,7 +2582,7 @@ }, "FileFormat":{ "shape":"FaqFileFormat", - "documentation":"The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
" + "documentation":"The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The default format is CSV.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
" }, "ClientToken":{ "shape":"ClientTokenName", @@ -2879,7 +2899,9 @@ }, "AlfrescoConfiguration":{ "shape":"AlfrescoConfiguration", - "documentation":"Provides the configuration information to connect to Alfresco as your data source.
" + "documentation":"Provides the configuration information to connect to Alfresco as your data source.
Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration API.
The file type of the document in the Blob field.
The file type of the document in the Blob field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the HTML start and closing tags (<HTML>content</HTML>) around the content.
The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.
The identifier of the index for the search.
" }, "QueryText":{ "shape":"QueryText", @@ -6734,23 +6757,23 @@ }, "AttributeFilter":{ "shape":"AttributeFilter", - "documentation":"Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.
The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.
The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.
" + "documentation":"An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.
" }, "RequestedDocumentAttributes":{ "shape":"DocumentAttributeKeyList", - "documentation":"An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.
" + "documentation":"An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.
" }, "QueryResultTypeFilter":{ "shape":"QueryResultType", - "documentation":"Sets the type of query. Only results for the specified query type are returned.
" + "documentation":"Sets the type of query result or response. Only results for the specified type are returned.
" }, "DocumentRelevanceOverrideConfigurations":{ "shape":"DocumentRelevanceOverrideConfigurationList", - "documentation":"Overrides relevance tuning configurations of fields or attributes set at the index level.
If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
" + "documentation":"Overrides relevance tuning configurations of fields/attributes set at the index level.
If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
" }, "PageNumber":{ "shape":"Integer", @@ -6783,7 +6806,7 @@ "members":{ "QueryId":{ "shape":"QueryId", - "documentation":"The identifier for the search. You use QueryId to identify the search when using the feedback API.
The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.
Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.
Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter.
The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
" + "documentation":"The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
" }, "Warnings":{ "shape":"WarningList", @@ -6835,7 +6858,7 @@ }, "AdditionalAttributes":{ "shape":"AdditionalResultAttributeList", - "documentation":"One or more additional attributes associated with the query result.
" + "documentation":"One or more additional fields/attributes associated with the query result.
" }, "DocumentId":{ "shape":"DocumentId", @@ -6855,15 +6878,15 @@ }, "DocumentAttributes":{ "shape":"DocumentAttributeList", - "documentation":"An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.
Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result is relevant to the query.
A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
" + "documentation":"A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
" }, "TableExcerpt":{ "shape":"TableExcerpt", @@ -6953,11 +6976,7 @@ "UPDATING" ] }, - "QueryText":{ - "type":"string", - "max":1000, - "min":1 - }, + "QueryText":{"type":"string"}, "QueryTextList":{ "type":"list", "member":{"shape":"QueryText"}, @@ -7131,6 +7150,94 @@ "max":73, "min":1 }, + "RetrieveRequest":{ + "type":"structure", + "required":[ + "IndexId", + "QueryText" + ], + "members":{ + "IndexId":{ + "shape":"IndexId", + "documentation":"The identifier of the index to retrieve relevant passages for the search.
" + }, + "QueryText":{ + "shape":"QueryText", + "documentation":"The input query text to retrieve relevant passages for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries.
" + }, + "AttributeFilter":{ + "shape":"AttributeFilter", + "documentation":"Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.
The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
" + }, + "DocumentRelevanceOverrideConfigurations":{ + "shape":"DocumentRelevanceOverrideConfigurationList", + "documentation":"Overrides relevance tuning configurations of fields/attributes set at the index level.
If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
" + }, + "PageNumber":{ + "shape":"Integer", + "documentation":"Retrieved relevant passages are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.
Sets the number of retrieved relevant passages that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.
" + }, + "UserContext":{ + "shape":"UserContext", + "documentation":"The user context token or user and group information.
" + } + } + }, + "RetrieveResult":{ + "type":"structure", + "members":{ + "QueryId":{ + "shape":"QueryId", + "documentation":"The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.
The results of the retrieved relevant passages for the search.
" + } + } + }, + "RetrieveResultItem":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResultId", + "documentation":"The identifier of the relevant passage result.
" + }, + "DocumentId":{ + "shape":"DocumentId", + "documentation":"The identifier of the document.
" + }, + "DocumentTitle":{ + "shape":"DocumentTitle", + "documentation":"The title of the document.
" + }, + "Content":{ + "shape":"Content", + "documentation":"The contents of the relevant passage.
" + }, + "DocumentURI":{ + "shape":"Url", + "documentation":"The URI of the original location of the document.
" + }, + "DocumentAttributes":{ + "shape":"DocumentAttributeList", + "documentation":"An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
A single retrieved relevant passage result.
" + }, + "RetrieveResultItemList":{ + "type":"list", + "member":{"shape":"RetrieveResultItem"} + }, "RoleArn":{ "type":"string", "max":1284, @@ -7458,10 +7565,10 @@ "members":{ "ScoreConfidence":{ "shape":"ScoreConfidence", - "documentation":"A relative ranking for how well the response matches the query.
" + "documentation":"A relative ranking for how relevant the response is to the query.
" } }, - "documentation":"Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.
" + "documentation":"Provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
" }, "ScoreConfidence":{ "type":"string", @@ -7524,7 +7631,7 @@ }, "WebCrawlerMode":{ "shape":"WebCrawlerMode", - "documentation":"You can choose one of the following modes:
HOST_ONLY – crawl only the website host names. For example, if the seed URL is \"abc.example.com\", then only URLs with host name \"abc.example.com\" are crawled.
SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is \"abc.example.com\", then \"a.abc.example.com\" and \"b.abc.example.com\" are also crawled.
EVERYTHING – crawl the website host names with subdomains and other domains that the web pages link to.
The default mode is set to HOST_ONLY.
You can choose one of the following modes:
HOST_ONLY—crawl only the website host names. For example, if the seed URL is \"abc.example.com\", then only URLs with host name \"abc.example.com\" are crawled.
SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is \"abc.example.com\", then \"a.abc.example.com\" and \"b.abc.example.com\" are also crawled.
EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to.
The default mode is set to HOST_ONLY.
Provides the configuration information for the seed or starting point URLs to crawl.
When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.
" @@ -7610,11 +7717,11 @@ }, "IncludeAttachmentFilePatterns":{ "shape":"DataSourceInclusionsExclusionsStrings", - "documentation":"A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
" }, "ExcludeAttachmentFilePatterns":{ "shape":"DataSourceInclusionsExclusionsStrings", - "documentation":"A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
" }, "DocumentDataFieldName":{ "shape":"DataSourceFieldName", @@ -9003,7 +9110,7 @@ }, "CrawlDepth":{ "shape":"CrawlDepth", - "documentation":"Specifies the number of levels in a website that you want to crawl.
The first level begins from the website seed or starting point URL. For example, if a website has three levels—index level (the seed in this example), sections level, and subsections level—and you are only interested in crawling information up to the sections level (levels 0-1), you can set your depth to 1.
The default crawl depth is set to 2.
" + "documentation":"The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
" }, "MaxLinksPerPage":{ "shape":"MaxLinksPerPage", diff --git a/botocore/data/stepfunctions/2016-11-23/endpoint-rule-set-1.json b/botocore/data/stepfunctions/2016-11-23/endpoint-rule-set-1.json index 59fd81e898..4d52cffb42 100644 --- a/botocore/data/stepfunctions/2016-11-23/endpoint-rule-set-1.json +++ b/botocore/data/stepfunctions/2016-11-23/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,23 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -71,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -140,193 +111,257 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsDualStack" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://states-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://states-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ + true, { - "ref": "Region" - }, - "us-gov-west-1" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], - "endpoint": { - "url": "https://states.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://states.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://states-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://states-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://states.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://states.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://states.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://states.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/botocore/data/stepfunctions/2016-11-23/service-2.json b/botocore/data/stepfunctions/2016-11-23/service-2.json index f2913493b1..8c5cfb419f 100644 --- a/botocore/data/stepfunctions/2016-11-23/service-2.json +++ b/botocore/data/stepfunctions/2016-11-23/service-2.json @@ -47,11 +47,32 @@ {"shape":"StateMachineDeleting"}, {"shape":"StateMachineLimitExceeded"}, {"shape":"StateMachineTypeNotSupported"}, - {"shape":"TooManyTags"} + {"shape":"TooManyTags"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} ], - "documentation":"Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.
If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.
You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.
To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.
You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.
Related operations:
" + }, "DeleteActivity":{ "name":"DeleteActivity", "http":{ @@ -77,7 +98,38 @@ {"shape":"InvalidArn"}, {"shape":"ValidationException"} ], - "documentation":"Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
For EXPRESS state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Deletes a state machine alias.
After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.
Related operations:
" + }, + "DeleteStateMachineVersion":{ + "name":"DeleteStateMachineVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStateMachineVersionInput"}, + "output":{"shape":"DeleteStateMachineVersionOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidArn"}, + {"shape":"ConflictException"} + ], + "documentation":"Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.
Deleting a state machine version won't terminate its in-progress executions.
You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
" }, "DescribeActivity":{ "name":"DescribeActivity", @@ -105,7 +157,7 @@ {"shape":"ExecutionDoesNotExist"}, {"shape":"InvalidArn"} ], - "documentation":"Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.
Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Returns details about a state machine alias.
Related operations:
" }, "DescribeStateMachineForExecution":{ "name":"DescribeStateMachineForExecution", @@ -147,7 +214,7 @@ {"shape":"ExecutionDoesNotExist"}, {"shape":"InvalidArn"} ], - "documentation":"Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.
Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Related operations:
" + }, + "ListStateMachineVersions":{ + "name":"ListStateMachineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStateMachineVersionsInput"}, + "output":{"shape":"ListStateMachineVersionsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidArn"}, + {"shape":"InvalidToken"} + ], + "documentation":"Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Related operations:
" + }, "ListStateMachines":{ "name":"ListStateMachines", "http":{ @@ -252,6 +351,25 @@ ], "documentation":"List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.
Related operations:
", + "idempotent":true + }, "SendTaskFailure":{ "name":"SendTaskFailure", "http":{ @@ -316,7 +434,7 @@ {"shape":"StateMachineDeleting"}, {"shape":"ValidationException"} ], - "documentation":"Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version.
StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.
StartExecution isn't idempotent for EXPRESS workflows.
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.
Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.
Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.
You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.
UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response.
This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.
Related operations:
" } }, "shapes":{ @@ -566,6 +702,11 @@ "documentation":"The maximum number of workers concurrently polling for activity tasks has been reached.
", "exception":true }, + "AliasDescription":{ + "type":"string", + "max":256, + "sensitive":true + }, "Arn":{ "type":"string", "max":256, @@ -593,6 +734,12 @@ }, "documentation":"An object that describes workflow billing details.
" }, + "CharacterRestrictedName":{ + "type":"string", + "max":80, + "min":1, + "pattern":"^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$" + }, "CloudWatchEventsExecutionDataDetails":{ "type":"structure", "members":{ @@ -613,6 +760,14 @@ }, "documentation":"" }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
", + "exception":true + }, "ConnectorParameters":{ "type":"string", "max":262144, @@ -650,6 +805,44 @@ } } }, + "CreateStateMachineAliasInput":{ + "type":"structure", + "required":[ + "name", + "routingConfiguration" + ], + "members":{ + "description":{ + "shape":"AliasDescription", + "documentation":"A description for the state machine alias.
" + }, + "name":{ + "shape":"CharacterRestrictedName", + "documentation":"The name of the state machine alias.
To avoid conflict with version ARNs, don't use an integer in the name of the alias.
" + }, + "routingConfiguration":{ + "shape":"RoutingConfigurationList", + "documentation":"The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.
The Amazon Resource Name (ARN) that identifies the created state machine alias.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The date the state machine alias was created.
" + } + } + }, "CreateStateMachineInput":{ "type":"structure", "required":[ @@ -685,6 +878,14 @@ "tracingConfiguration":{ "shape":"TracingConfiguration", "documentation":"Selects whether X-Ray tracing is enabled.
" + }, + "publish":{ + "shape":"Publish", + "documentation":"Set to true to publish the first version of the state machine during creation. The default is false.
Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
The date the state machine is created.
" + }, + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.
The Amazon Resource Name (ARN) of the state machine alias to delete.
" + } + } + }, + "DeleteStateMachineAliasOutput":{ + "type":"structure", + "members":{ + } + }, "DeleteStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], @@ -741,6 +961,21 @@ "members":{ } }, + "DeleteStateMachineVersionInput":{ + "type":"structure", + "required":["stateMachineVersionArn"], + "members":{ + "stateMachineVersionArn":{ + "shape":"LongArn", + "documentation":"The Amazon Resource Name (ARN) of the state machine version to delete.
" + } + } + }, + "DeleteStateMachineVersionOutput":{ + "type":"structure", + "members":{ + } + }, "DescribeActivityInput":{ "type":"structure", "required":["activityArn"], @@ -814,7 +1049,7 @@ }, "stopDate":{ "shape":"Timestamp", - "documentation":"If the execution has already ended, the date the execution stopped.
" + "documentation":"If the execution ended, the date the execution stopped.
" }, "input":{ "shape":"SensitiveData", @@ -841,6 +1076,14 @@ "cause":{ "shape":"SensitiveCause", "documentation":"The cause string if the state machine execution failed.
" + }, + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.
The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.
The Amazon Resource Name (ARN) of the state machine alias.
" + } + } + }, + "DescribeStateMachineAliasOutput":{ + "type":"structure", + "members":{ + "stateMachineAliasArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the state machine alias.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the state machine alias.
" + }, + "description":{ + "shape":"AliasDescription", + "documentation":"A description of the alias.
" + }, + "routingConfiguration":{ + "shape":"RoutingConfigurationList", + "documentation":"The routing configuration of the alias.
" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"The date the state machine alias was created.
" + }, + "updateDate":{ + "shape":"Timestamp", + "documentation":"The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
" + } + } + }, "DescribeStateMachineForExecutionInput":{ "type":"structure", "required":["executionArn"], @@ -962,6 +1244,10 @@ "label":{ "shape":"MapRunLabel", "documentation":"A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
The revision identifier for the state machine. The first revision ID when you create the state machine is null.
Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.
The Amazon Resource Name (ARN) of the state machine to describe.
" + "documentation":"The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
The Amazon Resource Name (ARN) that identifies the state machine.
" + "documentation":"The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
The date the state machine is created.
" + "documentation":"The date the state machine is created.
For a state machine version, creationDate is the date the version was created.
A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
The revision identifier for the state machine.
Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.
The description of the state machine version.
" } } }, @@ -1100,7 +1394,7 @@ }, "stateMachineArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the executed state machine.
" + "documentation":"The Amazon Resource Name (ARN) of the state machine that ran the execution.
" }, "name":{ "shape":"Name", @@ -1126,6 +1420,14 @@ "shape":"UnsignedInteger", "documentation":"The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.
The Amazon Resource Name (ARN) of the state machine version associated with the execution.
If the state machine execution was started with an unqualified ARN, it returns null.
If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.
The Amazon Resource Name (ARN) of the state machine alias used to start an execution.
If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.
" } }, "documentation":"Contains details about an execution.
" @@ -1144,6 +1446,14 @@ "roleArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
" + }, + "stateMachineAliasArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
" + }, + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
" } }, "documentation":"Contains details about the start of the execution.
" @@ -1650,7 +1960,7 @@ "members":{ "stateMachineArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn or a stateMachineArn, but not both.
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn or a stateMachineArn, but not both.
You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.
If you specify a state machine version ARN, this API returns a list of aliases for that version.
" + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
" + } + } + }, + "ListStateMachineAliasesOutput":{ + "type":"structure", + "required":["stateMachineAliases"], + "members":{ + "stateMachineAliases":{ + "shape":"StateMachineAliasList", + "documentation":"Aliases for the state machine.
" + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) of the state machine.
" + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
" + } + } + }, + "ListStateMachineVersionsOutput":{ + "type":"structure", + "required":["stateMachineVersions"], + "members":{ + "stateMachineVersions":{ + "shape":"StateMachineVersionList", + "documentation":"Versions for the state machine.
" + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) of the state machine.
" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"Only publish the state machine version if the current state machine's revision ID matches the specified ID.
Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns ConflictException.
To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.
An optional description of the state machine version.
" + } + } + }, + "PublishStateMachineVersionOutput":{ + "type":"structure", + "required":[ + "creationDate", + "stateMachineVersionArn" + ], + "members":{ + "creationDate":{ + "shape":"Timestamp", + "documentation":"The date the version was created.
" + }, + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
" + } + } + }, "ResourceNotFound":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "resourceName":{"shape":"Arn"} }, - "documentation":"Could not find the referenced resource. Only state machine and activity ARNs are supported.
", + "documentation":"Could not find the referenced resource.
", "exception":true }, "ReverseOrder":{"type":"boolean"}, + "RevisionId":{"type":"string"}, + "RoutingConfigurationList":{ + "type":"list", + "member":{"shape":"RoutingConfigurationListItem"}, + "max":2, + "min":1 + }, + "RoutingConfigurationListItem":{ + "type":"structure", + "required":[ + "stateMachineVersionArn", + "weight" + ], + "members":{ + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
If you specify the ARN of a second version, it must belong to the same state machine as the first version.
" + }, + "weight":{ + "shape":"VersionWeight", + "documentation":"The percentage of traffic you want to route to the second state machine version. The sum of the weights in the routing configuration must be equal to 100.
" + } + }, + "documentation":"Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.
" + }, "SendTaskFailureInput":{ "type":"structure", "required":["taskToken"], @@ -2119,17 +2554,25 @@ "min":0, "sensitive":true }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request would cause a service quota to be exceeded.
HTTP Status Code: 402
", + "exception":true + }, "StartExecutionInput":{ "type":"structure", "required":["stateMachineArn"], "members":{ "stateMachineArn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the state machine to execute.
" + "documentation":"The Amazon Resource Name (ARN) of the state machine to execute.
The stateMachineArn parameter accepts one of the following inputs:
An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.
A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10
Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.
A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.
The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters \" # % \\ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
" + "documentation":"Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
special characters \" # % \\ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
" }, "input":{ "shape":"SensitiveData", @@ -2279,6 +2722,28 @@ }, "documentation":"Contains details about an exit from a state during an execution.
" }, + "StateMachineAliasList":{ + "type":"list", + "member":{"shape":"StateMachineAliasListItem"} + }, + "StateMachineAliasListItem":{ + "type":"structure", + "required":[ + "stateMachineAliasArn", + "creationDate" + ], + "members":{ + "stateMachineAliasArn":{ + "shape":"LongArn", + "documentation":"The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
The creation date of a state machine alias.
" + } + }, + "documentation":"Contains details about a specific state machine alias.
" + }, "StateMachineAlreadyExists":{ "type":"structure", "members":{ @@ -2365,6 +2830,28 @@ "documentation":"", "exception":true }, + "StateMachineVersionList":{ + "type":"list", + "member":{"shape":"StateMachineVersionListItem"} + }, + "StateMachineVersionListItem":{ + "type":"structure", + "required":[ + "stateMachineVersionArn", + "creationDate" + ], + "members":{ + "stateMachineVersionArn":{ + "shape":"LongArn", + "documentation":"The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
The creation date of a state machine version.
" + } + }, + "documentation":"Contains details about a specific state machine version.
" + }, "StopExecutionInput":{ "type":"structure", "required":["executionArn"], @@ -2796,6 +3283,34 @@ "members":{ } }, + "UpdateStateMachineAliasInput":{ + "type":"structure", + "required":["stateMachineAliasArn"], + "members":{ + "stateMachineAliasArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the state machine alias.
" + }, + "description":{ + "shape":"AliasDescription", + "documentation":"A description of the state machine alias.
" + }, + "routingConfiguration":{ + "shape":"RoutingConfigurationList", + "documentation":"The routing configuration of the state machine alias.
An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.
The date and time the state machine alias was updated.
" + } + } + }, "UpdateStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], @@ -2814,11 +3329,19 @@ }, "loggingConfiguration":{ "shape":"LoggingConfiguration", - "documentation":"The LoggingConfiguration data type is used to set CloudWatch Logs options.
Use the LoggingConfiguration data type to set CloudWatch Logs options.
Selects whether X-Ray tracing is enabled.
" + }, + "publish":{ + "shape":"Publish", + "documentation":"Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.
An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
The date and time the state machine was updated.
" + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"The revision identifier for the updated state machine.
" + }, + "stateMachineVersionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the published state machine version.
If the publish parameter isn't set to true, this field returns null.