From 4e0d5c4eeddceb0d3c3ce9db69321a445045e749 Mon Sep 17 00:00:00 2001
From: aws-sdk-cpp-automation Queries a knowledge base and generates responses based on the retrieved
* results. The response cites up to five sources but only selects the ones that
- * are relevant to the query. The numberOfResults
field
- * is currently unsupported for RetrieveAndGenerate
. Don't include it
- * in the vectorSearchConfiguration
- * object.See Also:
See Also:
AWS
* API Reference
An object containing a segment of the generated response that is based on a - * source in the knowledge base, alongside information about the - * source.
This data type is used in the following API operations:
Retrieve
+ * response – in the citations
field
RetrieveAndGenerate
+ * response – in the citations
field
Contains metadata about a part of the generated response that is accompanied - * by a citation.
This data type is used in the following API + * operations:
Retrieve
+ * response – in the generatedResponsePart
field
RetrieveAndGenerate
+ * response – in the generatedResponsePart
field
Contains configurations for response generation based on the knowledge base + * query results.
This data type is used in the following API + * operations:
Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline const PromptTemplate& GetPromptTemplate() const{ return m_promptTemplate; } + + /** + *Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline bool PromptTemplateHasBeenSet() const { return m_promptTemplateHasBeenSet; } + + /** + *Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline void SetPromptTemplate(const PromptTemplate& value) { m_promptTemplateHasBeenSet = true; m_promptTemplate = value; } + + /** + *Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline void SetPromptTemplate(PromptTemplate&& value) { m_promptTemplateHasBeenSet = true; m_promptTemplate = std::move(value); } + + /** + *Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline GenerationConfiguration& WithPromptTemplate(const PromptTemplate& value) { SetPromptTemplate(value); return *this;} + + /** + *Contains the template for the prompt that's sent to the model for response + * generation.
+ */ + inline GenerationConfiguration& WithPromptTemplate(PromptTemplate&& value) { SetPromptTemplate(std::move(value)); return *this;} + + private: + + PromptTemplate m_promptTemplate; + bool m_promptTemplateHasBeenSet = false; + }; + +} // namespace Model +} // namespace BedrockAgentRuntime +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/InvokeAgentRequest.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/InvokeAgentRequest.h index 4e0632019fb..1c1b1868d71 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/InvokeAgentRequest.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/InvokeAgentRequest.h @@ -282,32 +282,50 @@ namespace Model /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline const SessionState& GetSessionState() const{ return m_sessionState; } /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline bool SessionStateHasBeenSet() const { return m_sessionStateHasBeenSet; } /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline void SetSessionState(const SessionState& value) { m_sessionStateHasBeenSet = true; m_sessionState = value; } /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline void SetSessionState(SessionState&& value) { m_sessionStateHasBeenSet = true; m_sessionState = std::move(value); } /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline InvokeAgentRequest& WithSessionState(const SessionState& value) { SetSessionState(value); return *this;} /** - *Contains parameters that specify various attributes of the session.
+ *Contains parameters that specify various attributes of the session. For more + * information, see Control + * session context.
*/ inline InvokeAgentRequest& WithSessionState(SessionState&& value) { SetSessionState(std::move(value)); return *this;} diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h index c1c0e0670cb..fc9b6c7dc03 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseQuery.h @@ -24,7 +24,11 @@ namespace Model { /** - *Contains the query made to the knowledge base.
This data type is used + * in the following API operations:
Retrieve
+ * request – in the retrievalQuery
field
Contains details about how the results should be returned.
This data - * type is used in the following API operations:
Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
This data type is used in the following API + * operations:
retrievalConfiguration
field Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline const KnowledgeBaseVectorSearchConfiguration& GetVectorSearchConfiguration() const{ return m_vectorSearchConfiguration; } /** *Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline bool VectorSearchConfigurationHasBeenSet() const { return m_vectorSearchConfigurationHasBeenSet; } /** *Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline void SetVectorSearchConfiguration(const KnowledgeBaseVectorSearchConfiguration& value) { m_vectorSearchConfigurationHasBeenSet = true; m_vectorSearchConfiguration = value; } /** *Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline void SetVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration&& value) { m_vectorSearchConfigurationHasBeenSet = true; m_vectorSearchConfiguration = std::move(value); } /** *Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline KnowledgeBaseRetrievalConfiguration& WithVectorSearchConfiguration(const KnowledgeBaseVectorSearchConfiguration& value) { SetVectorSearchConfiguration(value); return *this;} /** *Contains details about how the results from the vector search should be - * returned.
+ * returned. For more information, see Query + * configurations. */ inline KnowledgeBaseRetrievalConfiguration& WithVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration&& value) { SetVectorSearchConfiguration(std::move(value)); return *this;} diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalResult.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalResult.h index 19b487698fe..0241b87ac63 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalResult.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseRetrievalResult.h @@ -25,8 +25,11 @@ namespace Model { /** - *Details about a result from querying the knowledge base.
This data + * type is used in the following API operations:
Retrieve
+ * response – in the retrievalResults
field
Contains details about the resource being queried.
This data type is + * used in the following API operations:
Retrieve
+ * request – in the knowledgeBaseConfiguration
field
RetrieveAndGenerate
+ * request – in the knowledgeBaseConfiguration
field
Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline const GenerationConfiguration& GetGenerationConfiguration() const{ return m_generationConfiguration; } + + /** + *Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline bool GenerationConfigurationHasBeenSet() const { return m_generationConfigurationHasBeenSet; } + + /** + *Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline void SetGenerationConfiguration(const GenerationConfiguration& value) { m_generationConfigurationHasBeenSet = true; m_generationConfiguration = value; } + + /** + *Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline void SetGenerationConfiguration(GenerationConfiguration&& value) { m_generationConfigurationHasBeenSet = true; m_generationConfiguration = std::move(value); } + + /** + *Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline KnowledgeBaseRetrieveAndGenerateConfiguration& WithGenerationConfiguration(const GenerationConfiguration& value) { SetGenerationConfiguration(value); return *this;} + + /** + *Contains configurations for response generation based on the knowwledge base + * query results.
+ */ + inline KnowledgeBaseRetrieveAndGenerateConfiguration& WithGenerationConfiguration(GenerationConfiguration&& value) { SetGenerationConfiguration(std::move(value)); return *this;} + + /** *The unique identifier of the knowledge base that is queried and the * foundation model used for generation.
@@ -167,6 +211,9 @@ namespace Model private: + GenerationConfiguration m_generationConfiguration; + bool m_generationConfigurationHasBeenSet = false; + Aws::String m_knowledgeBaseId; bool m_knowledgeBaseIdHasBeenSet = false; diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseVectorSearchConfiguration.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseVectorSearchConfiguration.h index a49e88bd5b8..8f4d4f0971f 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseVectorSearchConfiguration.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/KnowledgeBaseVectorSearchConfiguration.h @@ -24,7 +24,17 @@ namespace Model { /** - *Configurations for how to carry out the search.
This data type is used in the following API + * operations:
Retrieve
+ * request – in the vectorSearchConfiguration
field
RetrieveAndGenerate
+ * request – in the vectorSearchConfiguration
field
The number of results to return.
The
- * numberOfResults
field is currently unsupported for
- * RetrieveAndGenerate
. Don't include it in this field if you are
- * sending a RetrieveAndGenerate
request.
The number of source chunks to retrieve.
*/ inline int GetNumberOfResults() const{ return m_numberOfResults; } /** - *The number of results to return.
The
- * numberOfResults
field is currently unsupported for
- * RetrieveAndGenerate
. Don't include it in this field if you are
- * sending a RetrieveAndGenerate
request.
The number of source chunks to retrieve.
*/ inline bool NumberOfResultsHasBeenSet() const { return m_numberOfResultsHasBeenSet; } /** - *The number of results to return.
The
- * numberOfResults
field is currently unsupported for
- * RetrieveAndGenerate
. Don't include it in this field if you are
- * sending a RetrieveAndGenerate
request.
The number of source chunks to retrieve.
*/ inline void SetNumberOfResults(int value) { m_numberOfResultsHasBeenSet = true; m_numberOfResults = value; } /** - *The number of results to return.
The
- * numberOfResults
field is currently unsupported for
- * RetrieveAndGenerate
. Don't include it in this field if you are
- * sending a RetrieveAndGenerate
request.
The number of source chunks to retrieve.
*/ inline KnowledgeBaseVectorSearchConfiguration& WithNumberOfResults(int value) { SetNumberOfResults(value); return *this;} diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/PromptTemplate.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/PromptTemplate.h new file mode 100644 index 00000000000..1a1a6a716b7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/PromptTemplate.h @@ -0,0 +1,166 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#includeContains the template for the prompt that's sent to the model for response + * generation. For more information, see Knowledge + * base prompt templates.
This data type is used in the following API + * operations:
The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline const Aws::String& GetTextPromptTemplate() const{ return m_textPromptTemplate; } + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline bool TextPromptTemplateHasBeenSet() const { return m_textPromptTemplateHasBeenSet; } + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline void SetTextPromptTemplate(const Aws::String& value) { m_textPromptTemplateHasBeenSet = true; m_textPromptTemplate = value; } + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline void SetTextPromptTemplate(Aws::String&& value) { m_textPromptTemplateHasBeenSet = true; m_textPromptTemplate = std::move(value); } + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline void SetTextPromptTemplate(const char* value) { m_textPromptTemplateHasBeenSet = true; m_textPromptTemplate.assign(value); } + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline PromptTemplate& WithTextPromptTemplate(const Aws::String& value) { SetTextPromptTemplate(value); return *this;} + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline PromptTemplate& WithTextPromptTemplate(Aws::String&& value) { SetTextPromptTemplate(std::move(value)); return *this;} + + /** + *The template for the prompt that's sent to the model for response generation. + * You can include prompt placeholders, which become replaced before the prompt is + * sent to the model to provide instructions and context to the model. In addition, + * you can include XML tags to delineate meaningful sections of the prompt + * template.
For more information, see the following resources:
+ */ + inline PromptTemplate& WithTextPromptTemplate(const char* value) { SetTextPromptTemplate(value); return *this;} + + private: + + Aws::String m_textPromptTemplate; + bool m_textPromptTemplateHasBeenSet = false; + }; + +} // namespace Model +} // namespace BedrockAgentRuntime +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievalResultContent.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievalResultContent.h index aa2c3d5bf5e..a2d0f7db33f 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievalResultContent.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievalResultContent.h @@ -24,7 +24,15 @@ namespace Model { /** - *Contains the cited text from the data source.
This data type is used + * in the following API operations:
Retrieve
+ * response – in the content
field
RetrieveAndGenerate
+ * response – in the content
field
Retrieve
+ * response – in the content
field
Contains information about the location of the data source.
Contains information about the location of the data source.
This data + * type is used in the following API operations:
Retrieve
+ * response – in the location
field
RetrieveAndGenerate
+ * response – in the location
field
Retrieve
+ * response – in the locatino
field
Contains the S3 location of the data source.
This data type is used in + * the following API operations:
Retrieve
+ * response – in the s3Location
field
RetrieveAndGenerate
+ * response – in the s3Location
field
Retrieve
+ * response – in the s3Location
field
Contains details about the resource being queried.
This data type is + * used in the following API operations:
RetrieveAndGenerate
+ * request – in the retrieveAndGenerateConfiguration
field
Contains the query made to the knowledge base.
This data type is used + * in the following API operations:
RetrieveAndGenerate
+ * request – in the input
field
Contains the response generated from querying the knowledge - * base.
This + * data type is used in the following API operations:
RetrieveAndGenerate
+ * response – in the output
field
Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline const RetrieveAndGenerateInput& GetInput() const{ return m_input; } /** - *Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline bool InputHasBeenSet() const { return m_inputHasBeenSet; } /** - *Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline void SetInput(const RetrieveAndGenerateInput& value) { m_inputHasBeenSet = true; m_input = value; } /** - *Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline void SetInput(RetrieveAndGenerateInput&& value) { m_inputHasBeenSet = true; m_input = std::move(value); } /** - *Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline RetrieveAndGenerateRequest& WithInput(const RetrieveAndGenerateInput& value) { SetInput(value); return *this;} /** - *Contains the query made to the knowledge base.
+ *Contains the query to be made to the knowledge base.
*/ inline RetrieveAndGenerateRequest& WithInput(RetrieveAndGenerateInput&& value) { SetInput(std::move(value)); return *this;} /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline const RetrieveAndGenerateConfiguration& GetRetrieveAndGenerateConfiguration() const{ return m_retrieveAndGenerateConfiguration; } /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline bool RetrieveAndGenerateConfigurationHasBeenSet() const { return m_retrieveAndGenerateConfigurationHasBeenSet; } /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline void SetRetrieveAndGenerateConfiguration(const RetrieveAndGenerateConfiguration& value) { m_retrieveAndGenerateConfigurationHasBeenSet = true; m_retrieveAndGenerateConfiguration = value; } /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline void SetRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration&& value) { m_retrieveAndGenerateConfigurationHasBeenSet = true; m_retrieveAndGenerateConfiguration = std::move(value); } /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline RetrieveAndGenerateRequest& WithRetrieveAndGenerateConfiguration(const RetrieveAndGenerateConfiguration& value) { SetRetrieveAndGenerateConfiguration(value); return *this;} /** - *Contains details about the resource being queried and the foundation model - * used for generation.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline RetrieveAndGenerateRequest& WithRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration&& value) { SetRetrieveAndGenerateConfiguration(std::move(value)); return *this;} diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrieveAndGenerateSessionConfiguration.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrieveAndGenerateSessionConfiguration.h index 3bb40fa6fec..2fccc8ecb1e 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrieveAndGenerateSessionConfiguration.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrieveAndGenerateSessionConfiguration.h @@ -24,8 +24,11 @@ namespace Model { /** - *Contains configuration about the session with the knowledge - * base.
This + * data type is used in the following API operations:
RetrieveAndGenerate
+ * request – in the sessionConfiguration
field
Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline const KnowledgeBaseRetrievalConfiguration& GetRetrievalConfiguration() const{ return m_retrievalConfiguration; } /** - *Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline bool RetrievalConfigurationHasBeenSet() const { return m_retrievalConfigurationHasBeenSet; } /** - *Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline void SetRetrievalConfiguration(const KnowledgeBaseRetrievalConfiguration& value) { m_retrievalConfigurationHasBeenSet = true; m_retrievalConfiguration = value; } /** - *Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline void SetRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration&& value) { m_retrievalConfigurationHasBeenSet = true; m_retrievalConfiguration = std::move(value); } /** - *Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline RetrieveRequest& WithRetrievalConfiguration(const KnowledgeBaseRetrievalConfiguration& value) { SetRetrievalConfiguration(value); return *this;} /** - *Contains details about how the results should be returned.
+ *Contains configurations for the knowledge base query and retrieval process. + * For more information, see Query + * configurations.
*/ inline RetrieveRequest& WithRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration&& value) { SetRetrievalConfiguration(std::move(value)); return *this;} /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline const KnowledgeBaseQuery& GetRetrievalQuery() const{ return m_retrievalQuery; } /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline bool RetrievalQueryHasBeenSet() const { return m_retrievalQueryHasBeenSet; } /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline void SetRetrievalQuery(const KnowledgeBaseQuery& value) { m_retrievalQueryHasBeenSet = true; m_retrievalQuery = value; } /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline void SetRetrievalQuery(KnowledgeBaseQuery&& value) { m_retrievalQueryHasBeenSet = true; m_retrievalQuery = std::move(value); } /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline RetrieveRequest& WithRetrievalQuery(const KnowledgeBaseQuery& value) { SetRetrievalQuery(value); return *this;} /** - *The query to send the knowledge base.
+ *Contains the query to send the knowledge base.
*/ inline RetrieveRequest& WithRetrievalQuery(KnowledgeBaseQuery&& value) { SetRetrievalQuery(std::move(value)); return *this;} diff --git a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievedReference.h b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievedReference.h index 7cb428ce5ff..14afc836ec9 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievedReference.h +++ b/generated/src/aws-cpp-sdk-bedrock-agent-runtime/include/aws/bedrock-agent-runtime/model/RetrievedReference.h @@ -25,8 +25,14 @@ namespace Model { /** - *Contains metadata about a sources cited for the generated - * response.
This data type is used in the following API operations:
RetrieveAndGenerate
+ * response – in the retrievedReferences
field
+ * Retrieve
+ * response – in the retrievedReferences
field
Contains information about where the text with a citation begins and ends in - * the generated output.
This data type is used in the following API + * operations:
RetrieveAndGenerate
+ * response – in the span
field
Retrieve
+ * response – in the span
field
Contains the part of the generated text that contains a citation, alongside - * where it begins and ends.
This data type is used in the following API + * operations:
RetrieveAndGenerate
+ * response – in the textResponsePart
field
Retrieve
+ * response – in the textResponsePart
field
Retrieves a list of your historical cost allocation tag backfill requests. + *
Get a list of cost allocation tags. All inputs in the API are optional and * serve as filters. By default, all cost allocation tags are returned. @@ -1020,6 +1046,35 @@ namespace CostExplorer return SubmitAsync(&CostExplorerClient::ProvideAnomalyFeedback, request, handler, context); } + /** + *
Request a cost allocation tag backfill. This will backfill the activation
+ * status (either active
or inactive
) for all tag keys
+ * from para:BackfillFrom
up to the when this request is made.
You can request a backfill once every 24 hours.
Requests a Savings Plans recommendation generation. This enables you to
* calculate a fresh set of Savings Plans recommendations that takes your latest
diff --git a/generated/src/aws-cpp-sdk-ce/include/aws/ce/CostExplorerErrors.h b/generated/src/aws-cpp-sdk-ce/include/aws/ce/CostExplorerErrors.h
index 4816576cbc2..ac3388c80ab 100644
--- a/generated/src/aws-cpp-sdk-ce/include/aws/ce/CostExplorerErrors.h
+++ b/generated/src/aws-cpp-sdk-ce/include/aws/ce/CostExplorerErrors.h
@@ -47,7 +47,8 @@ enum class CostExplorerErrors
UNKNOWN = 100,
///////////////////////////////////////////////////////////////////////////////////////////
- BILL_EXPIRATION= static_cast The cost allocation tag backfill request structure that contains metadata
+ * and details of a certain backfill.See Also:
AWS
+ * API Reference
The date the backfill starts from.
+ */ + inline const Aws::String& GetBackfillFrom() const{ return m_backfillFrom; } + + /** + *The date the backfill starts from.
+ */ + inline bool BackfillFromHasBeenSet() const { return m_backfillFromHasBeenSet; } + + /** + *The date the backfill starts from.
+ */ + inline void SetBackfillFrom(const Aws::String& value) { m_backfillFromHasBeenSet = true; m_backfillFrom = value; } + + /** + *The date the backfill starts from.
+ */ + inline void SetBackfillFrom(Aws::String&& value) { m_backfillFromHasBeenSet = true; m_backfillFrom = std::move(value); } + + /** + *The date the backfill starts from.
+ */ + inline void SetBackfillFrom(const char* value) { m_backfillFromHasBeenSet = true; m_backfillFrom.assign(value); } + + /** + *The date the backfill starts from.
+ */ + inline CostAllocationTagBackfillRequest& WithBackfillFrom(const Aws::String& value) { SetBackfillFrom(value); return *this;} + + /** + *The date the backfill starts from.
+ */ + inline CostAllocationTagBackfillRequest& WithBackfillFrom(Aws::String&& value) { SetBackfillFrom(std::move(value)); return *this;} + + /** + *The date the backfill starts from.
+ */ + inline CostAllocationTagBackfillRequest& WithBackfillFrom(const char* value) { SetBackfillFrom(value); return *this;} + + + /** + *The time when the backfill was requested.
+ */ + inline const Aws::String& GetRequestedAt() const{ return m_requestedAt; } + + /** + *The time when the backfill was requested.
+ */ + inline bool RequestedAtHasBeenSet() const { return m_requestedAtHasBeenSet; } + + /** + *The time when the backfill was requested.
+ */ + inline void SetRequestedAt(const Aws::String& value) { m_requestedAtHasBeenSet = true; m_requestedAt = value; } + + /** + *The time when the backfill was requested.
+ */ + inline void SetRequestedAt(Aws::String&& value) { m_requestedAtHasBeenSet = true; m_requestedAt = std::move(value); } + + /** + *The time when the backfill was requested.
+ */ + inline void SetRequestedAt(const char* value) { m_requestedAtHasBeenSet = true; m_requestedAt.assign(value); } + + /** + *The time when the backfill was requested.
+ */ + inline CostAllocationTagBackfillRequest& WithRequestedAt(const Aws::String& value) { SetRequestedAt(value); return *this;} + + /** + *The time when the backfill was requested.
+ */ + inline CostAllocationTagBackfillRequest& WithRequestedAt(Aws::String&& value) { SetRequestedAt(std::move(value)); return *this;} + + /** + *The time when the backfill was requested.
+ */ + inline CostAllocationTagBackfillRequest& WithRequestedAt(const char* value) { SetRequestedAt(value); return *this;} + + + /** + *The backfill completion time.
+ */ + inline const Aws::String& GetCompletedAt() const{ return m_completedAt; } + + /** + *The backfill completion time.
+ */ + inline bool CompletedAtHasBeenSet() const { return m_completedAtHasBeenSet; } + + /** + *The backfill completion time.
+ */ + inline void SetCompletedAt(const Aws::String& value) { m_completedAtHasBeenSet = true; m_completedAt = value; } + + /** + *The backfill completion time.
+ */ + inline void SetCompletedAt(Aws::String&& value) { m_completedAtHasBeenSet = true; m_completedAt = std::move(value); } + + /** + *The backfill completion time.
+ */ + inline void SetCompletedAt(const char* value) { m_completedAtHasBeenSet = true; m_completedAt.assign(value); } + + /** + *The backfill completion time.
+ */ + inline CostAllocationTagBackfillRequest& WithCompletedAt(const Aws::String& value) { SetCompletedAt(value); return *this;} + + /** + *The backfill completion time.
+ */ + inline CostAllocationTagBackfillRequest& WithCompletedAt(Aws::String&& value) { SetCompletedAt(std::move(value)); return *this;} + + /** + *The backfill completion time.
+ */ + inline CostAllocationTagBackfillRequest& WithCompletedAt(const char* value) { SetCompletedAt(value); return *this;} + + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline const CostAllocationTagBackfillStatus& GetBackfillStatus() const{ return m_backfillStatus; } + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline bool BackfillStatusHasBeenSet() const { return m_backfillStatusHasBeenSet; } + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline void SetBackfillStatus(const CostAllocationTagBackfillStatus& value) { m_backfillStatusHasBeenSet = true; m_backfillStatus = value; } + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline void SetBackfillStatus(CostAllocationTagBackfillStatus&& value) { m_backfillStatusHasBeenSet = true; m_backfillStatus = std::move(value); } + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline CostAllocationTagBackfillRequest& WithBackfillStatus(const CostAllocationTagBackfillStatus& value) { SetBackfillStatus(value); return *this;} + + /** + *The status of the cost allocation tag backfill request.
+ */ + inline CostAllocationTagBackfillRequest& WithBackfillStatus(CostAllocationTagBackfillStatus&& value) { SetBackfillStatus(std::move(value)); return *this;} + + + /** + *The time when the backfill status was last updated.
+ */ + inline const Aws::String& GetLastUpdatedAt() const{ return m_lastUpdatedAt; } + + /** + *The time when the backfill status was last updated.
+ */ + inline bool LastUpdatedAtHasBeenSet() const { return m_lastUpdatedAtHasBeenSet; } + + /** + *The time when the backfill status was last updated.
+ */ + inline void SetLastUpdatedAt(const Aws::String& value) { m_lastUpdatedAtHasBeenSet = true; m_lastUpdatedAt = value; } + + /** + *The time when the backfill status was last updated.
+ */ + inline void SetLastUpdatedAt(Aws::String&& value) { m_lastUpdatedAtHasBeenSet = true; m_lastUpdatedAt = std::move(value); } + + /** + *The time when the backfill status was last updated.
+ */ + inline void SetLastUpdatedAt(const char* value) { m_lastUpdatedAtHasBeenSet = true; m_lastUpdatedAt.assign(value); } + + /** + *The time when the backfill status was last updated.
+ */ + inline CostAllocationTagBackfillRequest& WithLastUpdatedAt(const Aws::String& value) { SetLastUpdatedAt(value); return *this;} + + /** + *The time when the backfill status was last updated.
+ */ + inline CostAllocationTagBackfillRequest& WithLastUpdatedAt(Aws::String&& value) { SetLastUpdatedAt(std::move(value)); return *this;} + + /** + *The time when the backfill status was last updated.
+ */ + inline CostAllocationTagBackfillRequest& WithLastUpdatedAt(const char* value) { SetLastUpdatedAt(value); return *this;} + + private: + + Aws::String m_backfillFrom; + bool m_backfillFromHasBeenSet = false; + + Aws::String m_requestedAt; + bool m_requestedAtHasBeenSet = false; + + Aws::String m_completedAt; + bool m_completedAtHasBeenSet = false; + + CostAllocationTagBackfillStatus m_backfillStatus; + bool m_backfillStatusHasBeenSet = false; + + Aws::String m_lastUpdatedAt; + bool m_lastUpdatedAtHasBeenSet = false; + }; + +} // namespace Model +} // namespace CostExplorer +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/CostAllocationTagBackfillStatus.h b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/CostAllocationTagBackfillStatus.h new file mode 100644 index 00000000000..67de241cbae --- /dev/null +++ b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/CostAllocationTagBackfillStatus.h @@ -0,0 +1,32 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#includeThe token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline const Aws::String& GetNextToken() const{ return m_nextToken; } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} + + + /** + *The maximum number of objects that are returned for this request.
+ */ + inline int GetMaxResults() const{ return m_maxResults; } + + /** + *The maximum number of objects that are returned for this request.
+ */ + inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } + + /** + *The maximum number of objects that are returned for this request.
+ */ + inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } + + /** + *The maximum number of objects that are returned for this request.
+ */ + inline ListCostAllocationTagBackfillHistoryRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} + + private: + + Aws::String m_nextToken; + bool m_nextTokenHasBeenSet = false; + + int m_maxResults; + bool m_maxResultsHasBeenSet = false; + }; + +} // namespace Model +} // namespace CostExplorer +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/ListCostAllocationTagBackfillHistoryResult.h b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/ListCostAllocationTagBackfillHistoryResult.h new file mode 100644 index 00000000000..e36a675974a --- /dev/null +++ b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/ListCostAllocationTagBackfillHistoryResult.h @@ -0,0 +1,155 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#includeThe list of historical cost allocation tag backfill requests.
+ */ + inline const Aws::VectorThe list of historical cost allocation tag backfill requests.
+ */ + inline void SetBackfillRequests(const Aws::VectorThe list of historical cost allocation tag backfill requests.
+ */ + inline void SetBackfillRequests(Aws::VectorThe list of historical cost allocation tag backfill requests.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& WithBackfillRequests(const Aws::VectorThe list of historical cost allocation tag backfill requests.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& WithBackfillRequests(Aws::VectorThe list of historical cost allocation tag backfill requests.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& AddBackfillRequests(const CostAllocationTagBackfillRequest& value) { m_backfillRequests.push_back(value); return *this; } + + /** + *The list of historical cost allocation tag backfill requests.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& AddBackfillRequests(CostAllocationTagBackfillRequest&& value) { m_backfillRequests.push_back(std::move(value)); return *this; } + + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline const Aws::String& GetNextToken() const{ return m_nextToken; } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(const Aws::String& value) { m_nextToken = value; } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(Aws::String&& value) { m_nextToken = std::move(value); } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline void SetNextToken(const char* value) { m_nextToken.assign(value); } + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} + + /** + *The token to retrieve the next set of results. Amazon Web Services provides + * the token when the response from a previous call has more results than the + * maximum page size.
+ */ + inline ListCostAllocationTagBackfillHistoryResult& WithNextToken(const char* value) { SetNextToken(value); return *this;} + + + + inline const Aws::String& GetRequestId() const{ return m_requestId; } + + + inline void SetRequestId(const Aws::String& value) { m_requestId = value; } + + + inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } + + + inline void SetRequestId(const char* value) { m_requestId.assign(value); } + + + inline ListCostAllocationTagBackfillHistoryResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} + + + inline ListCostAllocationTagBackfillHistoryResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} + + + inline ListCostAllocationTagBackfillHistoryResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} + + private: + + Aws::VectorThe date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline const Aws::String& GetBackfillFrom() const{ return m_backfillFrom; } + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline bool BackfillFromHasBeenSet() const { return m_backfillFromHasBeenSet; } + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline void SetBackfillFrom(const Aws::String& value) { m_backfillFromHasBeenSet = true; m_backfillFrom = value; } + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline void SetBackfillFrom(Aws::String&& value) { m_backfillFromHasBeenSet = true; m_backfillFrom = std::move(value); } + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline void SetBackfillFrom(const char* value) { m_backfillFromHasBeenSet = true; m_backfillFrom.assign(value); } + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline StartCostAllocationTagBackfillRequest& WithBackfillFrom(const Aws::String& value) { SetBackfillFrom(value); return *this;} + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline StartCostAllocationTagBackfillRequest& WithBackfillFrom(Aws::String&& value) { SetBackfillFrom(std::move(value)); return *this;} + + /** + *The date you want the backfill to start from. The date can only be a first + * day of the month (a billing start date). Dates can't precede the previous twelve + * months, or in the future.
+ */ + inline StartCostAllocationTagBackfillRequest& WithBackfillFrom(const char* value) { SetBackfillFrom(value); return *this;} + + private: + + Aws::String m_backfillFrom; + bool m_backfillFromHasBeenSet = false; + }; + +} // namespace Model +} // namespace CostExplorer +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/StartCostAllocationTagBackfillResult.h b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/StartCostAllocationTagBackfillResult.h new file mode 100644 index 00000000000..98e91b2cead --- /dev/null +++ b/generated/src/aws-cpp-sdk-ce/include/aws/ce/model/StartCostAllocationTagBackfillResult.h @@ -0,0 +1,92 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#includeAn object containing detailed metadata of your new backfill request.
+ */ + inline const CostAllocationTagBackfillRequest& GetBackfillRequest() const{ return m_backfillRequest; } + + /** + *An object containing detailed metadata of your new backfill request.
+ */ + inline void SetBackfillRequest(const CostAllocationTagBackfillRequest& value) { m_backfillRequest = value; } + + /** + *An object containing detailed metadata of your new backfill request.
+ */ + inline void SetBackfillRequest(CostAllocationTagBackfillRequest&& value) { m_backfillRequest = std::move(value); } + + /** + *An object containing detailed metadata of your new backfill request.
+ */ + inline StartCostAllocationTagBackfillResult& WithBackfillRequest(const CostAllocationTagBackfillRequest& value) { SetBackfillRequest(value); return *this;} + + /** + *An object containing detailed metadata of your new backfill request.
+ */ + inline StartCostAllocationTagBackfillResult& WithBackfillRequest(CostAllocationTagBackfillRequest&& value) { SetBackfillRequest(std::move(value)); return *this;} + + + + inline const Aws::String& GetRequestId() const{ return m_requestId; } + + + inline void SetRequestId(const Aws::String& value) { m_requestId = value; } + + + inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } + + + inline void SetRequestId(const char* value) { m_requestId.assign(value); } + + + inline StartCostAllocationTagBackfillResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} + + + inline StartCostAllocationTagBackfillResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} + + + inline StartCostAllocationTagBackfillResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} + + private: + + CostAllocationTagBackfillRequest m_backfillRequest; + + Aws::String m_requestId; + }; + +} // namespace Model +} // namespace CostExplorer +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-ce/source/CostExplorerClient.cpp b/generated/src/aws-cpp-sdk-ce/source/CostExplorerClient.cpp index 57ecbab99b5..f2292829e09 100644 --- a/generated/src/aws-cpp-sdk-ce/source/CostExplorerClient.cpp +++ b/generated/src/aws-cpp-sdk-ce/source/CostExplorerClient.cpp @@ -48,11 +48,13 @@ #includeDescribes a DHCP configuration option.
The name of a DHCP option.
+ */ inline const Aws::String& GetKey() const{ return m_key; } - + /** + *The name of a DHCP option.
+ */ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } - + /** + *The name of a DHCP option.
+ */ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } - + /** + *The name of a DHCP option.
+ */ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } - + /** + *The name of a DHCP option.
+ */ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } - + /** + *The name of a DHCP option.
+ */ inline NewDhcpConfiguration& WithKey(const Aws::String& value) { SetKey(value); return *this;} - + /** + *The name of a DHCP option.
+ */ inline NewDhcpConfiguration& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} - + /** + *The name of a DHCP option.
+ */ inline NewDhcpConfiguration& WithKey(const char* value) { SetKey(value); return *this;} - + /** + *The values for the DHCP option.
+ */ inline const Aws::VectorThe values for the DHCP option.
+ */ inline bool ValuesHasBeenSet() const { return m_valuesHasBeenSet; } - + /** + *The values for the DHCP option.
+ */ inline void SetValues(const Aws::VectorThe values for the DHCP option.
+ */ inline void SetValues(Aws::VectorThe values for the DHCP option.
+ */ inline NewDhcpConfiguration& WithValues(const Aws::VectorThe values for the DHCP option.
+ */ inline NewDhcpConfiguration& WithValues(Aws::VectorThe values for the DHCP option.
+ */ inline NewDhcpConfiguration& AddValues(const Aws::String& value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } - + /** + *The values for the DHCP option.
+ */ inline NewDhcpConfiguration& AddValues(Aws::String&& value) { m_valuesHasBeenSet = true; m_values.push_back(std::move(value)); return *this; } - + /** + *The values for the DHCP option.
+ */ inline NewDhcpConfiguration& AddValues(const char* value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } private: diff --git a/generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/SearchTransitGatewayRoutesRequest.h b/generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/SearchTransitGatewayRoutesRequest.h index bbc949f159a..da8491c7e41 100644 --- a/generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/SearchTransitGatewayRoutesRequest.h +++ b/generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/SearchTransitGatewayRoutesRequest.h @@ -273,26 +273,22 @@ namespace Model /** - *The maximum number of routes to return. If a value is not provided, the - * default is 1000.
+ *The maximum number of routes to return.
*/ inline int GetMaxResults() const{ return m_maxResults; } /** - *The maximum number of routes to return. If a value is not provided, the - * default is 1000.
+ *The maximum number of routes to return.
*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** - *The maximum number of routes to return. If a value is not provided, the - * default is 1000.
+ *The maximum number of routes to return.
*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** - *The maximum number of routes to return. If a value is not provided, the - * default is 1000.
+ *The maximum number of routes to return.
*/ inline SearchTransitGatewayRoutesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} diff --git a/generated/src/aws-cpp-sdk-ec2/source/model/NewDhcpConfiguration.cpp b/generated/src/aws-cpp-sdk-ec2/source/model/NewDhcpConfiguration.cpp index db08f37d202..7e99ba7017d 100644 --- a/generated/src/aws-cpp-sdk-ec2/source/model/NewDhcpConfiguration.cpp +++ b/generated/src/aws-cpp-sdk-ec2/source/model/NewDhcpConfiguration.cpp @@ -39,7 +39,7 @@ NewDhcpConfiguration& NewDhcpConfiguration::operator =(const XmlNode& xmlNode) if(!resultNode.IsNull()) { - XmlNode keyNode = resultNode.FirstChild("key"); + XmlNode keyNode = resultNode.FirstChild("Key"); if(!keyNode.IsNull()) { m_key = Aws::Utils::Xml::DecodeEscapedXmlText(keyNode.GetText()); diff --git a/generated/src/aws-cpp-sdk-ecs/include/aws/ecs/ECSClient.h b/generated/src/aws-cpp-sdk-ecs/include/aws/ecs/ECSClient.h index 95c8575c041..b908876e7e3 100644 --- a/generated/src/aws-cpp-sdk-ecs/include/aws/ecs/ECSClient.h +++ b/generated/src/aws-cpp-sdk-ecs/include/aws/ecs/ECSClient.h @@ -162,13 +162,13 @@ namespace ECS * definition. If the number of tasks running in a service drops below the *desiredCount
, Amazon ECS runs another copy of the task in the
* specified cluster. To update an existing service, see the UpdateService
- * action. The following change began on March 21, 2024. When the - * task definition revision is not specified, Amazon ECS resolves the task - * definition revision before it authorizes the task definition.
In
- * addition to maintaining the desired count of tasks in your service, you can
- * optionally run your service behind one or more load balancers. The load
- * balancers distribute traffic across the tasks that are associated with the
- * service. For more information, see On March 21, 2024, a change was made to resolve the task
+ * definition revision before authorization. When a task definition revision is not
+ * specified, authorization will occur using the latest revision of a task
+ * definition. In addition to maintaining the desired count of tasks
+ * in your service, you can optionally run your service behind one or more load
+ * balancers. The load balancers distribute traffic across the tasks that are
+ * associated with the service. For more information, see Service
* load balancing in the Amazon Elastic Container Service Developer
* Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by
@@ -289,10 +289,11 @@ namespace ECS
* information, see Amazon
* ECS deployment types in the Amazon Elastic Container Service Developer
- * Guide. The following change began on March 21, 2024. When the
- * task definition revision is not specified, Amazon ECS resolves the task
- * definition revision before it authorizes the task definition. For
- * information about the maximum number of task sets and otther quotas, see . On March 21, 2024, a change was made to resolve the
+ * task definition revision before authorization. When a task definition revision
+ * is not specified, authorization will occur using the latest revision of a task
+ * definition. For information about the maximum number of task sets
+ * and otther quotas, see Amazon
* ECS service quotas in the Amazon Elastic Container Service Developer
* Guide.See Also:
Starts a new task using the specified task definition.
The - * following change began on March 21, 2024. When the task definition revision is - * not specified, Amazon ECS resolves the task definition revision before it - * authorizes the task definition.
You can allow Amazon ECS to place - * tasks for you, or you can customize how Amazon ECS places tasks using placement - * constraints and placement strategies. For more information, see Starts a new task using the specified task definition.
On March + * 21, 2024, a change was made to resolve the task definition revision before + * authorization. When a task definition revision is not specified, authorization + * will occur using the latest revision of a task definition.
You + * can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS + * places tasks using placement constraints and placement strategies. For more + * information, see Scheduling * Tasks in the Amazon Elastic Container Service Developer Guide.
*Alternatively, you can use StartTask to use your own scheduler or @@ -1468,18 +1470,18 @@ namespace ECS /** *
Starts a new task from the specified task definition on the specified - * container instance or instances.
The following change began on - * March 21, 2024. When the task definition revision is not specified, Amazon ECS - * resolves the task definition revision before it authorizes the task - * definition.
Starting April 15, 2023, Amazon Web Services will not - * onboard new customers to Amazon Elastic Inference (EI), and will help current - * customers migrate their workloads to options that offer better price and - * performance. After April 15, 2023, new customers will not be able to launch - * instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon - * EC2. However, customers who have used Amazon EI at least once during the past - * 30-day period are considered current customers and will be able to continue - * using the service.
Alternatively, you can use RunTask to place
- * tasks for you. For more information, see On March 21, 2024, a change was
+ * made to resolve the task definition revision before authorization. When a task
+ * definition revision is not specified, authorization will occur using the latest
+ * revision of a task definition. Starting April 15, 2023, Amazon
+ * Web Services will not onboard new customers to Amazon Elastic Inference (EI),
+ * and will help current customers migrate their workloads to options that offer
+ * better price and performance. After April 15, 2023, new customers will not be
+ * able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon
+ * ECS, or Amazon EC2. However, customers who have used Amazon EI at least once
+ * during the past 30-day period are considered current customers and will be able
+ * to continue using the service. Alternatively, you can use RunTask
+ * to place tasks for you. For more information, see Scheduling
* Tasks in the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the
@@ -1870,17 +1872,18 @@ namespace ECS
}
/**
- * Modifies the parameters of a service. The following change
- * began on March 21, 2024. When the task definition revision is not specified,
- * Amazon ECS resolves the task definition revision before it authorizes the task
- * definition. For services using the rolling update
- * ( You can attach Amazon EBS volumes
- * to Amazon ECS tasks by configuring the volume when starting or running a task,
- * or when creating or updating a service. For more infomation, see Modifies the parameters of a service. On March 21, 2024, a
+ * change was made to resolve the task definition revision before authorization.
+ * When a task definition revision is not specified, authorization will occur using
+ * the latest revision of a task definition. For services using the
+ * rolling update ( You can attach Amazon
+ * EBS volumes to Amazon ECS tasks by configuring the volume when starting or
+ * running a task, or when creating or updating a service. For more infomation, see
+ * Amazon
* EBS volumes in the Amazon Elastic Container Service Developer Guide.
* You can update your volume configurations and trigger a new deployment.
diff --git a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceClient.h b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceClient.h
index d7f4586d8c4..a3cd86971c9 100644
--- a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceClient.h
+++ b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceClient.h
@@ -310,6 +310,31 @@ namespace finspace
return SubmitAsync(&FinspaceClient::DeleteKxCluster, request, handler, context);
}
+ /**
+ * Deletes the specified nodes from a cluster. ECS
) you can update the desired count, deployment configuration,
- * network configuration, load balancers, service registries, enable ECS managed
- * tags option, propagate tags option, task placement constraints and strategies,
- * and task definition. When you update any of these parameters, Amazon ECS starts
- * new tasks with the new configuration. ECS
) you can update the desired count, deployment
+ * configuration, network configuration, load balancers, service registries, enable
+ * ECS managed tags option, propagate tags option, task placement constraints and
+ * strategies, and task definition. When you update any of these parameters, Amazon
+ * ECS starts new tasks with the new configuration. See Also:
AWS
+ * API Reference
Deletes the specified database and all of its associated data. This action is
* irreversible. You must copy any data out of the database before deleting it if
diff --git a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceServiceClientModel.h b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceServiceClientModel.h
index 4ee673bce2e..d5045c2586a 100644
--- a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceServiceClientModel.h
+++ b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/FinspaceServiceClientModel.h
@@ -27,6 +27,7 @@
#include A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values:
PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -152,7 +152,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -184,7 +184,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -216,7 +216,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -248,7 +248,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -280,7 +280,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -312,7 +312,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory dbPath
attribute that defines the path within the
@@ -344,7 +344,7 @@ namespace Model
/**
*
A list of change request objects that are run in order. A change request
* object consists of changeType
, s3Path
, and
- * dbPath
. A changeType can has the following values:
dbPath
. A changeType can have the following values: PUT – Adds or updates files in a database.
DELETE – Deletes * files in a database.
All the change requests require a
* mandatory A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. A unique identifier for the kdb environment. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. The name of the cluster, for which you want to delete the nodes. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. A unique identifier for the node that you want to delete. The size of the network attached storage. The size of the network attached storage. For storage type
+ * The size of the network attached storage. The size of the network attached storage. For storage type
+ * The size of the network attached storage. The size of the network attached storage. For storage type
+ * The size of the network attached storage. The size of the network attached storage. For storage type
+ * Specifies the status of the cluster nodes.
+ *
+ * Specifies the status of the cluster nodes.
+ *
+ * Specifies the status of the cluster nodes.
+ *
+ * Specifies the status of the cluster nodes.
+ *
+ * Specifies the status of the cluster nodes.
+ *
+ * Specifies the status of the cluster nodes.
+ *
+ * Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query. The Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query. Contains metadata about the sources cited for the generated response. An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source. An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source. This data type is used in the following API operations: Retrieve response – in the RetrieveAndGenerate response – in the Contains metadata about a textual part of the generated response that is accompanied by a citation. Contains metadata about a part of the generated response that is accompanied by a citation. Contains metadata about a part of the generated response that is accompanied by a citation. This data type is used in the following API operations: Retrieve response – in the RetrieveAndGenerate response – in the Contains the template for the prompt that's sent to the model for response generation. Contains configurations for response generation based on the knowledge base query results. This data type is used in the following API operations: Contains parameters that specify various attributes of the session. Contains parameters that specify various attributes of the session. For more information, see Control session context. The text of the query made to the knowledge base. Contains the query made to the knowledge base. Contains the query made to the knowledge base. This data type is used in the following API operations: Retrieve request – in the Contains details about how the results from the vector search should be returned. Contains details about how the results from the vector search should be returned. For more information, see Query configurations. Contains details about how the results should be returned. This data type is used in the following API operations: Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations. This data type is used in the following API operations: Retrieve request – in the RetrieveAndGenerate request – in the The level of relevance of the result to the query. Details about a result from querying the knowledge base. Details about a result from querying the knowledge base. This data type is used in the following API operations: Retrieve response – in the Contains configurations for response generation based on the knowwledge base query results. The unique identifier of the knowledge base that is queried and the foundation model used for generation. Contains configurations for how to retrieve and return the knowledge base query. Contains details about the resource being queried. Contains details about the resource being queried. This data type is used in the following API operations: Retrieve request – in the RetrieveAndGenerate request – in the The number of results to return. The The number of source chunks to retrieve. By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a Configurations for how to carry out the search. Configurations for how to perform the search query and return results. For more information, see Query configurations. This data type is used in the following API operations: Retrieve request – in the RetrieveAndGenerate request – in the The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template. For more information, see the following resources: Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates. This data type is used in the following API operations: The cited text from the data source. Contains the cited text from the data source. Contains the cited text from the data source. This data type is used in the following API operations: Retrieve response – in the RetrieveAndGenerate response – in the Retrieve response – in the The type of the location of the data source. Contains information about the location of the data source. Contains information about the location of the data source. This data type is used in the following API operations: Retrieve response – in the RetrieveAndGenerate response – in the Retrieve response – in the The S3 URI of the data source. Contains the S3 location of the data source. Contains the S3 location of the data source. This data type is used in the following API operations: Retrieve response – in the RetrieveAndGenerate response – in the Retrieve response – in the The type of resource that is queried by the request. Contains details about the resource being queried. Contains details about the resource being queried. This data type is used in the following API operations: RetrieveAndGenerate request – in the The query made to the knowledge base. Contains the query made to the knowledge base. Contains the query made to the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate request – in the The response generated from querying the knowledge base. Contains the response generated from querying the knowledge base. Contains the response generated from querying the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate response – in the Contains the query made to the knowledge base. Contains the query to be made to the knowledge base. Contains details about the resource being queried and the foundation model used for generation. Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations. The ARN of the KMS key encrypting the session. Contains configuration about the session with the knowledge base. Contains configuration about the session with the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate request – in the Contains details about how the results should be returned. Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations. The query to send the knowledge base. Contains the query to send the knowledge base. Contains information about the location of the data source. Contains metadata about a sources cited for the generated response. Contains metadata about a source cited for the generated response. This data type is used in the following API operations: RetrieveAndGenerate response – in the Retrieve response – in the Contains attributes that persist across a session and the values of those attributes. Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Session context. Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context. Where the text with a citation starts in the generated output. Contains information about where the text with a citation begins and ends in the generated output. Contains information about where the text with a citation begins and ends in the generated output. This data type is used in the following API operations: RetrieveAndGenerate response – in the Retrieve response – in the The part of the generated text that contains a citation. Contains the part of the generated text that contains a citation, alongside where it begins and ends. Contains the part of the generated text that contains a citation, alongside where it begins and ends. This data type is used in the following API operations: RetrieveAndGenerate response – in the Retrieve response – in the Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage. Retrieves a list of your historical cost allocation tag backfill requests. Modifies the feedback property of a given cost anomaly. Request a cost allocation tag backfill. This will backfill the activation status (either You can request a backfill once every 24 hours. A request to backfill is already in progress. Once the previous request is complete, you can create another request. The cost allocation tag structure. This includes detailed metadata for the The date the backfill starts from. The time when the backfill was requested. The backfill completion time. The status of the cost allocation tag backfill request. The time when the backfill status was last updated. The cost allocation tag backfill request structure that contains metadata and details of a certain backfill. You made too many calls in a short period of time. Try again later. The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. The maximum number of objects that are returned for this request. The list of historical cost allocation tag backfill requests. The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. The date you want the backfill to start from. The date can only be a first day of the month (a billing start date). Dates can't precede the previous twelve months, or in the future. An object containing detailed metadata of your new backfill request. The name of a DHCP option. The values for the DHCP option. Describes a DHCP configuration option. The maximum number of routes to return. If a value is not provided, the default is 1000. The maximum number of routes to return. Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. Tasks for services that don't use a load balancer are considered healthy if they're in the There are two service scheduler strategies available: You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for If a service uses the If a service uses the If a service uses either the When creating a service that uses the When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. Tasks for services that don't use a load balancer are considered healthy if they're in the There are two service scheduler strategies available: You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for If a service uses the If a service uses the If a service uses either the When creating a service that uses the When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. Create a task set in the specified cluster and service. This is used when a service uses the The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition. For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide. Create a task set in the specified cluster and service. This is used when a service uses the On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide. Starts a new task using the specified task definition. The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time. Starts a new task using the specified task definition. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time. Starts a new task from the specified task definition on the specified container instance or instances. The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. Starts a new task from the specified task definition on the specified container instance or instances. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. Modifies the parameters of a service. The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition. For services using the rolling update ( You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. For services using the blue/green ( For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy. If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, If The When UpdateService stops a task during a deployment, the equivalent of When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic. Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes. By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy. Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination. Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service. You must have a service-linked role when you update any of the following service properties: For more information about the role see the Modifies the parameters of a service. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. For services using the rolling update ( You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. For services using the blue/green ( For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy. If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, If The When UpdateService stops a task during a deployment, the equivalent of When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic. Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes. By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy. Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination. Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service. You must have a service-linked role when you update any of the following service properties: For more information about the role see the Deletes a kdb cluster. Deletes the specified nodes from a cluster. A list of change request objects that are run in order. A change request object consists of PUT – Adds or updates files in a database. DELETE – Deletes files in a database. All the change requests require a mandatory Here are few examples of how you can use the change request object: This request adds a single sym file at database root location. This request adds files in the given This request adds files in the given This request deletes the 2020.01.02 partition of the database. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it. A list of change request objects that are run in order. A change request object consists of PUT – Adds or updates files in a database. DELETE – Deletes files in a database. All the change requests require a mandatory Here are few examples of how you can use the change request object: This request adds a single sym file at database root location. This request adds files in the given This request adds files in the given This request deletes the 2020.01.02 partition of the database. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it. A unique identifier for the kdb environment. The name of the cluster, for which you want to delete the nodes. A unique identifier for the node that you want to delete. The size of the network attached storage. The size of the network attached storage. For storage type The structure containing the size and type of the network attached storage (NAS_1) file system volume. The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. Specifies the status of the cluster nodes. A structure that stores metadata for a kdb node.dbPath
attribute that defines the path within the
diff --git a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/DeleteKxClusterNodeRequest.h b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/DeleteKxClusterNodeRequest.h
new file mode 100644
index 00000000000..dc8b99374a0
--- /dev/null
+++ b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/DeleteKxClusterNodeRequest.h
@@ -0,0 +1,171 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+#pragma once
+#include SSD_1000
and SSD_250
you can select the minimum size
+ * as 1200 GB or increments of 2400 GB. For storage type HDD_12
you
+ * can select the minimum size as 6000 GB or increments of 6000 GB.SSD_1000
and SSD_250
you can select the minimum size
+ * as 1200 GB or increments of 2400 GB. For storage type HDD_12
you
+ * can select the minimum size as 6000 GB or increments of 6000 GB.SSD_1000
and SSD_250
you can select the minimum size
+ * as 1200 GB or increments of 2400 GB. For storage type HDD_12
you
+ * can select the minimum size as 6000 GB or increments of 6000 GB.SSD_1000
and SSD_250
you can select the minimum size
+ * as 1200 GB or increments of 2400 GB. For storage type HDD_12
you
+ * can select the minimum size as 6000 GB or increments of 6000 GB.
+ */
+ inline const KxNodeStatus& GetStatus() const{ return m_status; }
+
+ /**
+ * RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.
+ */
+ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
+
+ /**
+ * RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.
+ */
+ inline void SetStatus(const KxNodeStatus& value) { m_statusHasBeenSet = true; m_status = value; }
+
+ /**
+ * RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.
+ */
+ inline void SetStatus(KxNodeStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
+
+ /**
+ * RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.
+ */
+ inline KxNode& WithStatus(const KxNodeStatus& value) { SetStatus(value); return *this;}
+
+ /**
+ * RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.
+ */
+ inline KxNode& WithStatus(KxNodeStatus&& value) { SetStatus(std::move(value)); return *this;}
+
private:
Aws::String m_nodeId;
@@ -180,6 +224,9 @@ namespace Model
Aws::Utils::DateTime m_launchTime;
bool m_launchTimeHasBeenSet = false;
+
+ KxNodeStatus m_status;
+ bool m_statusHasBeenSet = false;
};
} // namespace Model
diff --git a/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/KxNodeStatus.h b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/KxNodeStatus.h
new file mode 100644
index 00000000000..5f17d0fd816
--- /dev/null
+++ b/generated/src/aws-cpp-sdk-finspace/include/aws/finspace/model/KxNodeStatus.h
@@ -0,0 +1,31 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+#pragma once
+#include RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.numberOfResults
field is currently unsupported for RetrieveAndGenerate
. Don't include it in the vectorSearchConfiguration object.
"
},
"Citations":{
"type":"list",
@@ -289,7 +289,17 @@
"documentation":"citations
fieldcitations
field
"
+ },
+ "GenerationConfiguration":{
+ "type":"structure",
+ "members":{
+ "promptTemplate":{
+ "shape":"PromptTemplate",
+ "documentation":"generatedResponsePart
fieldgeneratedResponsePart
field
",
"sensitive":true
},
"KnowledgeBaseQueryTextString":{
@@ -499,10 +509,10 @@
"members":{
"vectorSearchConfiguration":{
"shape":"KnowledgeBaseVectorSearchConfiguration",
- "documentation":"retrievalQuery
field
"
},
"KnowledgeBaseRetrievalResult":{
"type":"structure",
@@ -521,7 +531,7 @@
"documentation":"retrievalConfiguration
fieldretrievalConfiguration
field
"
},
"KnowledgeBaseRetrievalResults":{
"type":"list",
@@ -535,6 +545,10 @@
"modelArn"
],
"members":{
+ "generationConfiguration":{
+ "shape":"GenerationConfiguration",
+ "documentation":"retrievalResults
field
"
},
"KnowledgeBaseVectorSearchConfiguration":{
"type":"structure",
"members":{
"numberOfResults":{
"shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger",
- "documentation":"knowledgeBaseConfiguration
fieldknowledgeBaseConfiguration
fieldnumberOfResults
field is currently unsupported for RetrieveAndGenerate
. Don't include it in this field if you are sending a RetrieveAndGenerate
request.HYBRID
search using both vector embeddings and raw text, or SEMANTIC
search using only vector embeddings. For other vector store configurations, only SEMANTIC
search is available. For more information, see Test a knowledge base.
"
},
"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger":{
"type":"integer",
"box":true,
- "max":25,
+ "max":100,
"min":1
},
"LambdaArn":{"type":"string"},
@@ -820,6 +834,16 @@
"key":{"shape":"String"},
"value":{"shape":"String"}
},
+ "PromptTemplate":{
+ "type":"structure",
+ "members":{
+ "textPromptTemplate":{
+ "shape":"TextPromptTemplate",
+ "documentation":"vectorSearchConfiguration
fieldvectorSearchConfiguration
field
",
"sensitive":true
},
"RetrievalResultLocation":{
@@ -965,7 +989,7 @@
"documentation":"content
fieldcontent
fieldcontent
field
",
"sensitive":true
},
"RetrievalResultLocationType":{
@@ -980,7 +1004,7 @@
"documentation":"location
fieldlocation
fieldlocatino
field
"
},
"RetrieveAndGenerateConfiguration":{
"type":"structure",
@@ -995,7 +1019,7 @@
"documentation":"s3Location
fields3Location
fields3Location
field
"
},
"RetrieveAndGenerateInput":{
"type":"structure",
@@ -1006,7 +1030,7 @@
"documentation":"retrieveAndGenerateConfiguration
field
",
"sensitive":true
},
"RetrieveAndGenerateInputTextString":{
@@ -1023,7 +1047,7 @@
"documentation":"input
field
",
"sensitive":true
},
"RetrieveAndGenerateRequest":{
@@ -1032,11 +1056,11 @@
"members":{
"input":{
"shape":"RetrieveAndGenerateInput",
- "documentation":"output
field
"
},
"RetrieveAndGenerateType":{
"type":"string",
@@ -1103,11 +1127,11 @@
},
"retrievalConfiguration":{
"shape":"KnowledgeBaseRetrievalConfiguration",
- "documentation":"sessionConfiguration
field
"
},
"RetrievedReferences":{
"type":"list",
@@ -1185,7 +1209,7 @@
"documentation":"retrievedReferences
fieldretrievedReferences
field
"
},
"SpanEndInteger":{
"type":"integer",
@@ -1233,6 +1257,12 @@
"max":1,
"min":0
},
+ "TextPromptTemplate":{
+ "type":"string",
+ "max":4000,
+ "min":1,
+ "sensitive":true
+ },
"TextResponsePart":{
"type":"structure",
"members":{
@@ -1245,7 +1275,7 @@
"documentation":"span
fieldspan
field
",
"sensitive":true
},
"ThrottlingException":{
diff --git a/tools/code-generation/api-descriptions/ce-2017-10-25.normal.json b/tools/code-generation/api-descriptions/ce-2017-10-25.normal.json
index fc065683209..db0850939f3 100644
--- a/tools/code-generation/api-descriptions/ce-2017-10-25.normal.json
+++ b/tools/code-generation/api-descriptions/ce-2017-10-25.normal.json
@@ -414,6 +414,20 @@
],
"documentation":"textResponsePart
fieldtextResponsePart
fieldactive
or inactive
) for all tag keys from para:BackfillFrom
up to the when this request is made.CostAllocationTag
object. desiredCount
, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.volumeConfigurations
is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.
REPLICA
- The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.DAEMON
- The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.minimumHealthyPercent
is 100%. The default value for a daemon service for minimumHealthyPercent
is 0%.ECS
deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING
state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING
state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.ECS
deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.CODE_DEPLOY
or EXTERNAL
deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING
state. This is while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.EXTERNAL
deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.desiredCount
, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.volumeConfigurations
is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.
REPLICA
- The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.DAEMON
- The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.minimumHealthyPercent
is 100%. The default value for a daemon service for minimumHealthyPercent
is 0%.ECS
deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING
state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING
state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.ECS
deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.CODE_DEPLOY
or EXTERNAL
deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING
state. This is while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.EXTERNAL
deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
"
+ "documentation":"
"
},
"StartTask":{
"name":"StartTask",
@@ -690,7 +690,7 @@
{"shape":"ClusterNotFoundException"},
{"shape":"UnsupportedFeatureException"}
],
- "documentation":"ECS
) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration. volumeConfigurations
is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations
null
, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.desiredCount
parameter.my_image:latest
), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.minimumHealthyPercent
and maximumPercent
, to determine the deployment strategy.
minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).docker stop
is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout. After this, SIGKILL
is sent and the containers are forcibly stopped. If the container handles the SIGTERM
gracefully and exits within 30 seconds from receiving it, no SIGKILL
is sent.
loadBalancers
,serviceRegistries
CreateService
request parameter role
. ECS
) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration. volumeConfigurations
is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations
null
, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.desiredCount
parameter.my_image:latest
), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.minimumHealthyPercent
and maximumPercent
, to determine the deployment strategy.
minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).docker stop
is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout. After this, SIGKILL
is sent and the containers are forcibly stopped. If the container handles the SIGTERM
gracefully and exits within 30 seconds from receiving it, no SIGKILL
is sent.
loadBalancers
,serviceRegistries
CreateService
request parameter role
. changeType
, s3Path
, and dbPath
. A changeType can has the following values:
dbPath
attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path
attribute defines the s3 source file path and is required for a PUT change type. The s3path
must end with a trailing / if it is a directory and must end without a trailing / if it is a file.
"
+ "documentation":"{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\", \"dbPath\":\"/\"}
s3Path
under the 2020.01.02 partition of the database.{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"}
s3Path
under the taq table partition of the database.[ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]
[{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]
[ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]
changeType
, s3Path
, and dbPath
. A changeType can have the following values:
dbPath
attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path
attribute defines the s3 source file path and is required for a PUT change type. The s3path
must end with a trailing / if it is a directory and must end without a trailing / if it is a file.
"
},
"clientToken":{
"shape":"ClientTokenString",
@@ -1960,6 +1977,39 @@
"members":{
}
},
+ "DeleteKxClusterNodeRequest":{
+ "type":"structure",
+ "required":[
+ "clusterName",
+ "nodeId",
+ "environmentId"
+ ],
+ "members":{
+ "environmentId":{
+ "shape":"KxEnvironmentId",
+ "documentation":"{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\", \"dbPath\":\"/\"}
s3Path
under the 2020.01.02 partition of the database.{ \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"}
s3Path
under the taq table partition of the database.[ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]
[{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]
[ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]
SSD_1000
and SSD_250
you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12
you can select the minimum size as 6000 GB or increments of 6000 GB.
"
}
},
"documentation":"RUNNING
– The node is actively serving.PROVISIONING
– The node is being prepared.