Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.
\nThis API operation creates the following resources.
\nCFN Stack Name with a maximum length of 128 characters and prefix\n athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23\n characters.
Lambda Function Name with a maximum length of 64 characters and prefix\n athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23\n characters.
Glue Connection Name with a maximum length of 255 characters and a prefix\n athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23\n characters.
Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.
\nFor a FEDERATED catalog, this API operation creates the following\n resources.
CFN Stack Name with a maximum length of 128 characters and prefix\n athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23\n characters.
Lambda Function Name with a maximum length of 64 characters and prefix\n athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23\n characters.
Glue Connection Name with a maximum length of 255 characters and a prefix\n athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23\n characters.
The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.
The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.
For FEDERATED type, we do not support IAM identity center.
The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE TABLE.
The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE,\n EXPLAIN, DESCRIBE, or SHOW TABLES.
Contains configuration information for the calculation.
" } diff --git a/models/bedrock-agent-runtime/service/2023-07-26/bedrock-agent-runtime-2023-07-26.json b/models/bedrock-agent-runtime/service/2023-07-26/bedrock-agent-runtime-2023-07-26.json index 98aade16..2b0c58e2 100644 --- a/models/bedrock-agent-runtime/service/2023-07-26/bedrock-agent-runtime-2023-07-26.json +++ b/models/bedrock-agent-runtime/service/2023-07-26/bedrock-agent-runtime-2023-07-26.json @@ -127,6 +127,12 @@ "traits": { "smithy.api#documentation": "The JSON-formatted string returned by the API invoked by the action group.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the action group output.
" + } } }, "traits": { @@ -413,6 +419,12 @@ "traits": { "smithy.api#documentation": "The output's output.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the output from the agent collaborator.
" + } } }, "traits": { @@ -1750,6 +1762,12 @@ "traits": { "smithy.api#documentation": "Indicates if the execution of the code timed out.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the output from the code interpreter.
" + } } }, "traits": { @@ -2702,6 +2720,18 @@ "traits": { "smithy.api#documentation": "The reason the interaction failed.
" } + }, + "failureCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The failure code for the trace.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Information about the failure that occurred.
" + } } }, "traits": { @@ -2873,6 +2903,12 @@ "traits": { "smithy.api#documentation": "The text in the response to the user.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the invoke agent operation.
" + } } }, "traits": { @@ -4953,6 +4989,12 @@ "traits": { "smithy.api#documentation": "The details of the output assessments used in the Guardrail Trace.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the Guardrail output.
" + } } }, "traits": { @@ -6535,6 +6577,12 @@ "traits": { "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "Contains information about the knowledge base output.
" + } } }, "traits": { @@ -7207,15 +7255,47 @@ "com.amazonaws.bedrockagentruntime#Metadata": { "type": "structure", "members": { + "startTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "In the final response, startTime is the start time of the agent invocation operation.
In the final response, endTime is the end time time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + } + }, + "operationTotalTimeMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The total time it took for the agent to complete execution. This field is only set for the final response.
" + } + }, + "clientRequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" + } + }, "usage": { "target": "com.amazonaws.bedrockagentruntime#Usage", "traits": { - "smithy.api#documentation": "Contains details of the foundation model usage.
" + "smithy.api#documentation": "Specific to model invocation and contains details about the usage of a foundation model.
" } } }, "traits": { - "smithy.api#documentation": "Provides details of the foundation model.
", + "smithy.api#documentation": "Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
", "smithy.api#sensitive": {} } }, diff --git a/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json b/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json index 598dd92d..e439b1cc 100644 --- a/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json +++ b/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json @@ -198,6 +198,27 @@ "smithy.api#documentation": "Contains details about an action group.
" } }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFields": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsValue" + } + }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#AdditionalModelRequestFieldsValue": { + "type": "document" + }, "com.amazonaws.bedrockagent#Agent": { "type": "structure", "members": { @@ -419,7 +440,7 @@ "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", "traits": { - "smithy.api#documentation": "The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nDefines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#AgentKnowledgeBase": { @@ -2553,6 +2574,16 @@ "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, + "com.amazonaws.bedrockagent#BedrockRerankingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + } + }, "com.amazonaws.bedrockagent#BucketOwnerAccountId": { "type": "string", "traits": { @@ -2742,7 +2773,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#ColumnName": { @@ -2754,6 +2785,23 @@ "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" } }, + "com.amazonaws.bedrockagent#ConcurrencyType": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automatic" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Manual" + } + } + } + }, "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { "type": "structure", "members": { @@ -2766,7 +2814,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#ConflictException": { @@ -3133,13 +3181,13 @@ "parentActionGroupSignature": { "target": "com.amazonaws.bedrockagent#ActionGroupSignature", "traits": { - "smithy.api#documentation": "Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, "flowIdentifier": { "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { @@ -3686,6 +3740,12 @@ "smithy.api#required": {} } }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, "flowId": { "target": "com.amazonaws.bedrockagent#FlowId", "traits": { @@ -6450,6 +6510,25 @@ } } }, + "com.amazonaws.bedrockagent#FieldForReranking": { + "type": "structure", + "members": { + "fieldName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the metadata field to include or exclude during reranking.
", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a metadata field to include or exclude during the reranking process.
" + } + }, "com.amazonaws.bedrockagent#FieldName": { "type": "string", "traits": { @@ -6459,6 +6538,19 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.bedrockagent#FieldsForReranking": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FieldForReranking" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#FilterList": { "type": "list", "member": { @@ -6527,6 +6619,31 @@ "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})$" } }, + "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#ConcurrencyType", + "traits": { + "smithy.api#documentation": "The type of concurrency to use for parallel node execution. Specify one of the following options:
\n\n Automatic - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
\n Manual - You specify which nodes can be executed in parallel.
The maximum number of nodes that can be executed concurrently in the flow.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
" + } + }, "com.amazonaws.bedrockagent#FlowAliasId": { "type": "string", "traits": { @@ -6633,6 +6750,12 @@ "smithy.api#required": {} } }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed concurrently.
" + } + }, "flowId": { "target": "com.amazonaws.bedrockagent#FlowId", "traits": { @@ -7038,10 +7161,28 @@ "traits": { "smithy.api#documentation": "Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" } + }, + "loop": { + "target": "com.amazonaws.bedrockagent#LoopFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a DoWhile loop in your flow.
" + } + }, + "loopInput": { + "target": "com.amazonaws.bedrockagent#LoopInputFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains input node configurations for a DoWhile loop in your flow.
" + } + }, + "loopController": { + "target": "com.amazonaws.bedrockagent#LoopControllerFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains controller node configurations for a DoWhile loop in your flow.
" + } } }, "traits": { - "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#FlowNodeIODataType": { @@ -7085,14 +7226,14 @@ "name": { "target": "com.amazonaws.bedrockagent#FlowNodeInputName", "traits": { - "smithy.api#documentation": "A name for the input that you can reference.
", + "smithy.api#documentation": "Specifies a name for the input that you can reference.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", "traits": { - "smithy.api#documentation": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#documentation": "Specifies the data type of the input. If the input doesn't match this type at runtime,\n a validation error will be thrown.
", "smithy.api#required": {} } }, @@ -7102,10 +7243,39 @@ "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", "smithy.api#required": {} } + }, + "category": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "Specifies how input data flows between iterations in a DoWhile\n loop.
\n\n LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define\n the condition that determines if the loop should continue.
\n ReturnValueToLoopStart - Defines data to pass back to the start\n of the loop's next iteration. Use this category for variables that you\n want to update for each loop iteration.
\n ExitLoop - Defines the value that's available once the loop ends.\n Use this category to expose loop results to nodes outside the loop.
Contains configurations for an input to a node.
" + "smithy.api#documentation": "Contains configurations for an input in an Amazon Bedrock Flows node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputCategory": { + "type": "enum", + "members": { + "LOOP_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopCondition" + } + }, + "RETURN_VALUE_TO_LOOP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReturnValueToLoopStart" + } + }, + "EXIT_LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExitLoop" + } + } } }, "com.amazonaws.bedrockagent#FlowNodeInputExpression": { @@ -7260,6 +7430,24 @@ "traits": { "smithy.api#enumValue": "InlineCode" } + }, + "LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Loop" + } + }, + "LOOP_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopInput" + } + }, + "LOOP_CONTROLLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopController" + } } } }, @@ -7616,6 +7804,42 @@ "traits": { "smithy.api#documentation": "Details about an unknown output for a node.
" } + }, + "missingLoopInputNode": { + "target": "com.amazonaws.bedrockagent#MissingLoopInputNodeFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a flow that's missing a required LoopInput node in a DoWhile loop.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
Details about a flow that includes incompatible node types in a DoWhile loop.
" + } + }, + "invalidLoopBoundary": { + "target": "com.amazonaws.bedrockagent#InvalidLoopBoundaryFlowValidationDetails", + "traits": { + "smithy.api#documentation": "Details about a flow that includes connections that violate loop boundary rules.
" + } } }, "traits": { @@ -7803,6 +8027,42 @@ "traits": { "smithy.api#enumValue": "UnknownNodeOutput" } + }, + "MISSING_LOOP_INPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingLoopInputNode" + } + }, + "MISSING_LOOP_CONTROLLER_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingLoopControllerNode" + } + }, + "MULTIPLE_LOOP_INPUT_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultipleLoopInputNodes" + } + }, + "MULTIPLE_LOOP_CONTROLLER_NODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultipleLoopControllerNodes" + } + }, + "LOOP_INCOMPATIBLE_NODE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopIncompatibleNodeType" + } + }, + "INVALID_LOOP_BOUNDARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidLoopBoundary" + } } } }, @@ -8640,6 +8900,12 @@ "smithy.api#required": {} } }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, "flowId": { "target": "com.amazonaws.bedrockagent#FlowId", "traits": { @@ -9443,6 +9709,35 @@ "smithy.api#documentation": "Details about incompatible data types in a connection between nodes.
" } }, + "com.amazonaws.bedrockagent#IncompatibleLoopNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Condition" + } + }, + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "COLLECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Collector" + } + } + } + }, "com.amazonaws.bedrockagent#InferenceConfiguration": { "type": "structure", "members": { @@ -10070,6 +10365,35 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.bedrockagent#InvalidLoopBoundaryFlowValidationDetails": { + "type": "structure", + "members": { + "connection": { + "target": "com.amazonaws.bedrockagent#FlowConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection that violates loop boundary rules.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The source node of the connection that violates DoWhile loop boundary rules.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The target node of the connection that violates DoWhile loop boundary rules.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a flow that contains connections that violate loop boundary rules.
" + } + }, "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { "type": "structure", "members": {}, @@ -10367,10 +10691,44 @@ "traits": { "smithy.api#documentation": "Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
" } + }, + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of results to retrieve from the knowledge base.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "promptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate", + "traits": { + "smithy.api#documentation": "A custom prompt template to use with the knowledge base for generating responses.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for reranking the retrieved results from the knowledge base to improve relevance.
" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseOrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for orchestrating the retrieval and generation process in the knowledge base node.
" + } } }, "traits": { - "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#KnowledgeBaseId": { @@ -10392,6 +10750,52 @@ "smithy.api#pattern": "^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, + "com.amazonaws.bedrockagent#KnowledgeBaseOrchestrationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate", + "traits": { + "smithy.api#documentation": "A custom prompt template for orchestrating the retrieval and generation process.
" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
" + } + }, + "performanceConfig": { + "target": "com.amazonaws.bedrockagent#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "The performance configuration options for the knowledge base retrieval and generation process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBasePromptTemplate": { + "type": "structure", + "members": { + "textPromptTemplate": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseTextPrompt", + "traits": { + "smithy.api#documentation": "The text of the prompt template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a custom prompt template for orchestrating the retrieval and generation process.
" + } + }, "com.amazonaws.bedrockagent#KnowledgeBaseResource": { "type": "resource", "operations": [ @@ -10589,6 +10993,16 @@ "smithy.api#documentation": "Contains details about a knowledge base.
" } }, + "com.amazonaws.bedrockagent#KnowledgeBaseTextPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#KnowledgeBaseType": { "type": "enum", "members": { @@ -10633,7 +11047,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#LexBotAliasArn": { @@ -10673,7 +11087,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#ListAgentActionGroups": { @@ -12072,6 +12486,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockagent#LoopControllerFlowNodeConfiguration": { + "type": "structure", + "members": { + "continueCondition": { + "target": "com.amazonaws.bedrockagent#FlowCondition", + "traits": { + "smithy.api#documentation": "Specifies the condition that determines when the flow exits the DoWhile loop. The loop\n executes until this condition evaluates to true.
", + "smithy.api#required": {} + } + }, + "maxIterations": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Specifies the maximum number of times the DoWhile loop can iterate before the flow\n exits the loop.
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the controller node of a DoWhile loop in the flow.
" + } + }, + "com.amazonaws.bedrockagent#LoopFlowNodeConfiguration": { + "type": "structure", + "members": { + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the DoWhile loop nodes and connections between nodes in the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the nodes of a DoWhile loop in your flow.
\nA DoWhile loop is made up of the following nodes:
\n\n Loop - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.
\n LoopInput - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.
Body nodes - These can be
\n\n LoopController - The node that evaluates whether the loop should continue or exit based on a condition.
These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.
" + } + }, + "com.amazonaws.bedrockagent#LoopIncompatibleNodeTypeFlowValidationDetails": { + "type": "structure", + "members": { + "node": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The Loop container node that contains an incompatible node.
The node type of the incompatible node in the DoWhile loop. Some node types, like a condition node, aren't allowed in a DoWhile loop.
", + "smithy.api#required": {} + } + }, + "incompatibleNodeName": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that's incompatible in the DoWhile loop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a flow that contains an incompatible node in a DoWhile loop.
" + } + }, + "com.amazonaws.bedrockagent#LoopInputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for the input node of a DoWhile loop in the flow.
" + } + }, "com.amazonaws.bedrockagent#MalformedConditionExpressionFlowValidationDetails": { "type": "structure", "members": { @@ -12293,6 +12784,27 @@ "target": "com.amazonaws.bedrockagent#MetadataAttribute" } }, + "com.amazonaws.bedrockagent#MetadataConfigurationForReranking": { + "type": "structure", + "members": { + "selectionMode": { + "target": "com.amazonaws.bedrockagent#RerankingMetadataSelectionMode", + "traits": { + "smithy.api#documentation": "The mode for selecting metadata fields for reranking.
", + "smithy.api#required": {} + } + }, + "selectiveModeConfiguration": { + "target": "com.amazonaws.bedrockagent#RerankingMetadataSelectiveModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for selective metadata field inclusion or exclusion during reranking.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how metadata fields should be handled during the reranking process.
" + } + }, "com.amazonaws.bedrockagent#MetadataSourceType": { "type": "enum", "members": { @@ -12444,19 +12956,49 @@ "smithy.api#documentation": "Details about missing ending nodes (such as FlowOutputNode) in the flow.
" } }, + "com.amazonaws.bedrockagent#MissingLoopControllerNodeFlowValidationDetails": { + "type": "structure", + "members": { + "loopNode": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The DoWhile loop in a flow that's missing a required LoopController node.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
The DoWhile loop in a flow that's missing a required LoopInput node.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
The name of the node missing configuration.
", + "smithy.api#documentation": "The name of the node missing a required configuration.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about a node missing required configuration.
" + "smithy.api#documentation": "Details about a node missing a required configuration.
" } }, "com.amazonaws.bedrockagent#MissingNodeInputFlowValidationDetails": { @@ -12657,6 +13199,36 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.bedrockagent#MultipleLoopControllerNodesFlowValidationDetails": { + "type": "structure", + "members": { + "loopNode": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The DoWhile loop in a flow that contains multiple LoopController nodes.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
The DoWhile loop in a flow that contains multiple LoopInput nodes.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
The latency optimization setting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The performance-related configuration options for the knowledge base retrieval and generation process.
" + } + }, "com.amazonaws.bedrockagent#PineconeConfiguration": { "type": "structure", "members": { @@ -13458,7 +14062,7 @@ "promptState": { "target": "com.amazonaws.bedrockagent#PromptState", "traits": { - "smithy.api#documentation": "Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING \u2013 DISABLED\n
\n ORCHESTRATION \u2013 ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED\n
\n POST_PROCESSING \u2013 DISABLED\n
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING \u2013 ENABLED\n
\n ORCHESTRATION \u2013 ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED\n
\n POST_PROCESSING \u2013 DISABLED\n
Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" } }, "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { @@ -14798,6 +15402,43 @@ "smithy.api#documentation": "Whether the action requires user confirmation.
" } }, + "com.amazonaws.bedrockagent#RerankingMetadataSelectionMode": { + "type": "enum", + "members": { + "SELECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTIVE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.bedrockagent#RerankingMetadataSelectiveModeConfiguration": { + "type": "union", + "members": { + "fieldsToInclude": { + "target": "com.amazonaws.bedrockagent#FieldsForReranking", + "traits": { + "smithy.api#documentation": "Specifies the metadata fields to include in the reranking process.
" + } + }, + "fieldsToExclude": { + "target": "com.amazonaws.bedrockagent#FieldsForReranking", + "traits": { + "smithy.api#documentation": "Specifies the metadata fields to exclude from the reranking process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the metadata fields to include or exclude during the reranking process when using selective mode.
" + } + }, "com.amazonaws.bedrockagent#ResourceNotFoundException": { "type": "structure", "members": { @@ -16658,13 +17299,13 @@ "parentActionGroupSignature": { "target": "com.amazonaws.bedrockagent#ActionGroupSignature", "traits": { - "smithy.api#documentation": "Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + "smithy.api#documentation": "Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" } }, "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", "traits": { - "smithy.api#documentation": "The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, "flowIdentifier": { "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { @@ -17417,6 +18064,12 @@ "smithy.api#required": {} } }, + "concurrencyConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasConcurrencyConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, "flowId": { "target": "com.amazonaws.bedrockagent#FlowId", "traits": { @@ -18068,6 +18721,90 @@ "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" } }, + "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingConfiguration": { + "type": "structure", + "members": { + "modelConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingModelConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Amazon Bedrock reranker model.
", + "smithy.api#required": {} + } + }, + "numberOfRerankedResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Specifies the number of results to return after reranking.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "metadataConfiguration": { + "target": "com.amazonaws.bedrockagent#MetadataConfigurationForReranking", + "traits": { + "smithy.api#documentation": "Specifies how metadata fields should be handled during the reranking process.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the Amazon Bedrock reranker model to improve the relevance of retrieved results.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchBedrockRerankingModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockRerankingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
", + "smithy.api#required": {} + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagent#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures the Amazon Bedrock model used for reranking retrieved results.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchRerankingConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#VectorSearchRerankingConfigurationType", + "traits": { + "smithy.api#documentation": "Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.
Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies how retrieved results from a knowledge base are reranked to improve relevance.
" + } + }, + "com.amazonaws.bedrockagent#VectorSearchRerankingConfigurationType": { + "type": "enum", + "members": { + "BEDROCK_RERANKING_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" + } + } + } + }, "com.amazonaws.bedrockagent#Version": { "type": "string", "traits": { diff --git a/models/bedrock-data-automation-runtime/service/2024-06-13/bedrock-data-automation-runtime-2024-06-13.json b/models/bedrock-data-automation-runtime/service/2024-06-13/bedrock-data-automation-runtime-2024-06-13.json index 8c118c79..7ff48873 100644 --- a/models/bedrock-data-automation-runtime/service/2024-06-13/bedrock-data-automation-runtime-2024-06-13.json +++ b/models/bedrock-data-automation-runtime/service/2024-06-13/bedrock-data-automation-runtime-2024-06-13.json @@ -712,6 +712,20 @@ } } }, + "com.amazonaws.bedrockdataautomationruntime#AssetProcessingConfiguration": { + "type": "structure", + "members": { + "video": { + "target": "com.amazonaws.bedrockdataautomationruntime#VideoAssetProcessingConfiguration", + "traits": { + "smithy.api#documentation": "Video asset processing configuration" + } + } + }, + "traits": { + "smithy.api#documentation": "Config containing asset processing related knobs for all modalities" + } + }, "com.amazonaws.bedrockdataautomationruntime#AutomationJobResource": { "type": "resource", "identifiers": { @@ -1089,6 +1103,12 @@ "smithy.api#documentation": "S3 uri.", "smithy.api#required": {} } + }, + "assetProcessingConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#AssetProcessingConfiguration", + "traits": { + "smithy.api#documentation": "Asset processing configuration" + } } }, "traits": { @@ -1525,6 +1545,34 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockdataautomationruntime#TimestampSegment": { + "type": "structure", + "members": { + "startTimeMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "Start timestamp in milliseconds", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "endTimeMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "End timestamp in milliseconds", + "smithy.api#range": { + "min": 300000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Timestamp segment" + } + }, "com.amazonaws.bedrockdataautomationruntime#UntagResource": { "type": "operation", "input": { @@ -1593,6 +1641,34 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.bedrockdataautomationruntime#VideoAssetProcessingConfiguration": { + "type": "structure", + "members": { + "segmentConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#VideoSegmentConfiguration", + "traits": { + "smithy.api#documentation": "Delimits the segment of the input that will be processed" + } + } + }, + "traits": { + "smithy.api#documentation": "Video asset processing configuration" + } + }, + "com.amazonaws.bedrockdataautomationruntime#VideoSegmentConfiguration": { + "type": "union", + "members": { + "timestampSegment": { + "target": "com.amazonaws.bedrockdataautomationruntime#TimestampSegment", + "traits": { + "smithy.api#documentation": "Timestamp segment" + } + } + }, + "traits": { + "smithy.api#documentation": "Delimits the segment of the input that will be processed" + } } } } \ No newline at end of file diff --git a/models/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json b/models/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json index 84b5a14a..3806e8db 100644 --- a/models/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json +++ b/models/bedrock-data-automation/service/2023-07-26/bedrock-data-automation-2023-07-26.json @@ -3022,6 +3022,12 @@ "traits": { "smithy.api#enumValue": "AUDIO" } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } } }, "traits": { diff --git a/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json b/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json index a03aac68..981be5d1 100644 --- a/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json +++ b/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json @@ -1463,6 +1463,12 @@ "smithy.api#documentation": "The contextual grounding policy configuration used to create a guardrail.
" } }, + "crossRegionConfig": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
\nFor more information, see the Amazon Bedrock User Guide.
" + } + }, "blockedInputMessaging": { "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { @@ -5088,6 +5094,12 @@ "smithy.api#documentation": "The contextual grounding policy used in the guardrail.
" } }, + "crossRegionDetails": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", + "traits": { + "smithy.api#documentation": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + } + }, "createdAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { @@ -6851,6 +6863,71 @@ "smithy.api#documentation": "The policy configuration details for the guardrails contextual grounding policy.
" } }, + "com.amazonaws.bedrock#GuardrailCrossRegionConfig": { + "type": "structure", + "members": { + "guardrailProfileIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileIdentifier", + "traits": { + "smithy.api#documentation": "The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
\nFor more information, see the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionDetails": { + "type": "structure", + "members": { + "guardrailProfileId": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileId", + "traits": { + "smithy.api#documentation": "The ID of the guardrail profile that your guardrail is using. Profile availability\n depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + } + }, + "guardrailProfileArn": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.
\nFor more information, see the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 30 + }, + "smithy.api#pattern": "^[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, + "com.amazonaws.bedrock#GuardrailCrossRegionGuardrailProfileIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 2048 + }, + "smithy.api#pattern": "^[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+|arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$" + } + }, "com.amazonaws.bedrock#GuardrailDescription": { "type": "string", "traits": { @@ -7749,6 +7826,12 @@ "smithy.api#documentation": "The date and time at which the guardrail was last updated.
", "smithy.api#required": {} } + }, + "crossRegionDetails": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", + "traits": { + "smithy.api#documentation": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + } } }, "traits": { @@ -13599,6 +13682,12 @@ "smithy.api#documentation": "The contextual grounding policy configuration used to update a guardrail.
" } }, + "crossRegionConfig": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "traits": { + "smithy.api#documentation": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
\nFor more information, see the Amazon Bedrock User Guide.
" + } + }, "blockedInputMessaging": { "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { diff --git a/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json b/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json index 5d989924..34054571 100644 --- a/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json +++ b/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json @@ -56,7 +56,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "This field is true if any of the key groups have public keys that CloudFront\n\t\t\tcan use to verify the signatures of signed URLs and signed cookies. If not, this field\n\t\t\tis false.
This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
A list of key groups, including the identifiers of the public keys in each key group\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } } }, "traits": { - "smithy.api#documentation": "A list of key groups, and the public keys in each key group, that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#ActiveTrustedSigners": { @@ -84,7 +84,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "This field is true if any of the Amazon Web Services accounts in the list are configured as\n\t\t\ttrusted signers. If not, this field is false.
This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } } }, "traits": { - "smithy.api#documentation": "A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#AliasICPRecordal": { @@ -118,12 +118,12 @@ "ICPRecordalStatus": { "target": "com.amazonaws.cloudfront#ICPRecordalStatus", "traits": { - "smithy.api#documentation": "The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus\n\t\t\tis set to APPROVED for all CNAMEs (aliases) in Amazon Web Services Regions outside of China.
\nThe status values returned are the following:
\n\n APPROVED indicates that the associated CNAME\n\t\t\t\t\thas a valid ICP recordal number. Multiple CNAMEs can be associated with a\n\t\t\t\t\tdistribution, and CNAMEs can correspond to different ICP recordals. To be marked\n\t\t\t\t\tas APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP\n\t\t\t\t\trecordal number associated with it.
\n\n SUSPENDED indicates that the associated CNAME\n\t\t\t\t\tdoes not have a valid ICP recordal number.
\n\n PENDING indicates that CloudFront can't determine\n\t\t\t\t\tthe ICP recordal status of the CNAME associated with the distribution because\n\t\t\t\t\tthere was an error in trying to determine the status. You can try again to see\n\t\t\t\t\tif the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED\n\t\t\t\t\tstatus.
\nThe Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in Amazon Web Services Regions outside of China.
The status values returned are the following:
APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with the China Regions, a CNAME must have one ICP recordal number associated with it.
SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.
Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions. The status is returned in the CloudFront\n\t\t\tresponse; you can't configure it yourself.
\nFor more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.
" + "smithy.api#documentation": "Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
" } }, "com.amazonaws.cloudfront#AliasICPRecordals": { @@ -150,19 +150,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of CNAME aliases, if any, that you want to associate with this\n\t\t\tdistribution.
", + "smithy.api#documentation": "The number of CNAME aliases, if any, that you want to associate with this distribution.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#AliasList", "traits": { - "smithy.api#documentation": "A complex type that contains the CNAME aliases, if any, that you want to associate\n\t\t\twith this distribution.
" + "smithy.api#documentation": "A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
" } } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.
" + "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
" } }, "com.amazonaws.cloudfront#AllowedMethods": { @@ -171,14 +171,14 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of HTTP methods that you want CloudFront to forward to your origin. Valid values\n\t\t\tare 2 (for GET and HEAD requests), 3 (for GET,\n\t\t\t\tHEAD, and OPTIONS requests) and 7 (for GET, HEAD,\n\t\t\t\tOPTIONS, PUT, PATCH, POST, and DELETE requests).
The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).
A complex type that contains the HTTP methods that you want CloudFront to process and\n\t\t\tforward to your origin.
", + "smithy.api#documentation": "A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
", "smithy.api#required": {} } }, @@ -187,7 +187,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that controls which HTTP methods CloudFront processes and forwards to your\n\t\t\tAmazon S3 bucket or your custom origin. There are three choices:
\nCloudFront forwards only GET and HEAD requests.
CloudFront forwards only GET, HEAD, and\n\t\t\t\t\t\tOPTIONS requests.
CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and\n\t\t\t\t\t\tDELETE requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or\n\t\t\tto your custom origin so users can't perform operations that you don't want them to. For\n\t\t\texample, you might not want users to have permissions to delete objects from your\n\t\t\torigin.
" + "smithy.api#documentation": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:
CloudFront forwards only GET and HEAD requests.
CloudFront forwards only GET, HEAD, and OPTIONS requests.
CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
" } }, "com.amazonaws.cloudfront#AnycastIpList": { @@ -259,27 +259,27 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Indicates the next page of the Anycast static IP list collection. To get the next page of the\n\t\t\tlist, use this value in the Marker field of your request.
Indicates the next page of the Anycast static IP list collection. To get the next page of the list, use this value in the Marker field of your request.
The maximum number of Anycast static IP list collections that you want returned in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of Anycast static IP list collections that you want returned in the response.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "If there are more items in the list collection than are in this response, this value is\n\t\t\ttrue.
If there are more items in the list collection than are in this response, this value is true.
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront\n\t\t\tdistribution.
\nWith this operation you can move an alias that's already in use on a CloudFront distribution\n\t\t\tto a different distribution in one step. This prevents the downtime that could occur if\n\t\t\tyou first remove the alias from one distribution and then separately add the alias to\n\t\t\tanother distribution.
\nTo use this operation to associate an alias with a distribution, you provide the alias\n\t\t\tand the ID of the target distribution for the alias. For more information, including how\n\t\t\tto set up the target distribution, prerequisites that you must complete, and other\n\t\t\trestrictions, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{TargetDistributionId}/associate-alias", @@ -654,33 +654,33 @@ "PathPattern": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The pattern (for example, images/*.jpg) that specifies which requests to\n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is\n\t\t\tcompared with path patterns in the order in which cache behaviors are listed in the\n\t\t\tdistribution.
You can optionally include a slash (/) at the beginning of the path\n\t\t\t\tpattern. For example, /images/*.jpg. CloudFront behavior is the same with or\n\t\t\t\twithout the leading /.
The path pattern for the default cache behavior is * and cannot be\n\t\t\tchanged. If the request for an object does not match the path pattern for any cache\n\t\t\tbehaviors, CloudFront applies the behavior in the default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.
You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.
The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.
For more information, see Path Pattern in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "TargetOriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of ID for the origin that you want CloudFront to route requests to\n\t\t\twhen they match this cache behavior.
The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.
We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or\n\t\t\tsigned cookies.
\nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account.\n\t\t\tThe signed URL or cookie contains information about which public key CloudFront should use to\n\t\t\tverify the signature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { - "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.
\nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { - "smithy.api#documentation": "The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nThe protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming\n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify\n\t\t\t\ttrue; if not, specify false. If you specify\n\t\t\t\ttrue for SmoothStreaming, you can still distribute other\n\t\t\tcontent using this cache behavior if the content matches the value of\n\t\t\t\tPathPattern.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior.\n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving\n\t\t\t\tCompressed Files in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
" } }, "LambdaFunctionAssociations": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", "traits": { - "smithy.api#documentation": "A complex type that contains zero or more Lambda@Edge function associations for a\n\t\t\tcache behavior.
" + "smithy.api#documentation": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { - "smithy.api#documentation": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.
The value of ID for the field-level encryption configuration that you\n\t\t\twant CloudFront to use for encrypting specific fields of data for this cache behavior.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to\n\t\t\tthis cache behavior. For more information, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The unique identifier of the cache policy that is attached to this cache behavior. For\n\t\t\tmore information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nA CacheBehavior must include either a CachePolicyId or\n\t\t\t\tForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.
The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
The unique identifier of the origin request policy that is attached to this cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
" } }, "ResponseHeadersPolicyId": { @@ -751,33 +751,33 @@ "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nA CacheBehavior must include either a CachePolicyId or\n\t\t\t\tForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "This field is deprecated. We recommend that you use the MinTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. For more information, see Managing How Long\n\t\t\t\tContent Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.
\nYou must specify 0 for MinTTL if you configure CloudFront to\n\t\t\tforward all headers to your origin (under Headers, if you specify\n\t\t\t\t1 for Quantity and * for\n\t\t\tName).
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
This field is deprecated. We recommend that you use the DefaultTTL field\n\t\t\tin a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin does not add HTTP\n\t\t\theaders such as Cache-Control max-age, Cache-Control s-maxage,\n\t\t\tand Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin adds HTTP headers such\n\t\t\tas Cache-Control max-age, Cache-Control s-maxage, and\n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
A complex type that describes how CloudFront processes requests.
\nYou must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.
\nFor the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIf you don't want to specify any cache behaviors, include only an empty\n\t\t\t\tCacheBehaviors element. Don't specify an empty individual\n\t\t\t\tCacheBehavior element, because this is invalid. For more information,\n\t\t\tsee CacheBehaviors.
To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.
\nFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that describes how CloudFront processes requests.
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.
If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't specify an empty individual CacheBehavior element, because this is invalid. For more information, see CacheBehaviors.
To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { @@ -802,7 +802,7 @@ "Items": { "target": "com.amazonaws.cloudfront#CacheBehaviorList", "traits": { - "smithy.api#documentation": "Optional: A complex type that contains cache behaviors for this distribution. If\n\t\t\t\tQuantity is 0, you can omit Items.
Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.
A cache policy.
\nWhen it's attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:
\nThe values that CloudFront includes in the cache key. These values can include HTTP\n\t\t\t\t\theaders, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\t\t\tobject in its cache that it can return to the viewer.
\nThe default, minimum, and maximum time to live (TTL) values that you want\n\t\t\t\t\tobjects to stay in the CloudFront cache.
\nThe headers, cookies, and query strings that are included in the cache key are also included\n\t\t\tin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a\n\t\t\tvalid object in its cache that matches the request's cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.
A cache policy.
When it's attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
A cache policy with this name already exists. You must provide a unique name. To\n\t\t\tmodify an existing cache policy, use UpdateCachePolicy.
A cache policy with this name already exists. You must provide a unique name. To modify an existing cache policy, use UpdateCachePolicy.
A comment to describe the cache policy. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "A comment to describe the cache policy. The comment cannot be longer than 128 characters.
" } }, "Name": { @@ -871,31 +871,31 @@ "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object's time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control or Expires\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of\n\t\t\t\tMinTTL is more than 86400 seconds, then the default value for this\n\t\t\tfield is the same as the value of MinTTL.
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before\n\t\t\tCloudFront sends another request to the origin to see if the object has been updated. CloudFront\n\t\t\tuses this value only when the origin sends Cache-Control or\n\t\t\t\tExpires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\t\tMinTTL or DefaultTTL is more than 31536000 seconds, then\n\t\t\tthe default value for this field is the same as the value of\n\t\t\tDefaultTTL.
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "ParametersInCacheKeyAndForwardedToOrigin": { "target": "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin", "traits": { - "smithy.api#documentation": "The HTTP headers, cookies, and URL query strings to include in the cache key. The values\n\t\t\tincluded in the cache key are also included in requests that CloudFront sends to the\n\t\t\torigin.
" + "smithy.api#documentation": "The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
" } } }, "traits": { - "smithy.api#documentation": "A cache policy configuration.
\nThis configuration determines the following:
\nThe values that CloudFront includes in the cache key. These values can include HTTP\n\t\t\t\t\theaders, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\t\t\tobject in its cache that it can return to the viewer.
\nThe default, minimum, and maximum time to live (TTL) values that you want\n\t\t\t\t\tobjects to stay in the CloudFront cache.
\nThe headers, cookies, and query strings that are included in the cache key are also included\n\t\t\tin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a\n\t\t\tvalid object in its cache that matches the request's cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.
A cache policy configuration.
This configuration determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
Determines whether any cookies in viewer requests are included in the cache key and in\n\t\t\trequests that CloudFront sends to the origin. Valid values are:
\n\n none \u2013 No cookies in viewer requests are included in the cache key or in\n\t\t\t\t\trequests that CloudFront sends to the origin. Even when this field is set to\n\t\t\t\t\tnone, any cookies that are listed in an\n\t\t\t\t\tOriginRequestPolicy\n are included in origin\n\t\t\t\t\trequests.
\n whitelist \u2013 Only the cookies in viewer requests that are listed in the\n\t\t\t\t\tCookieNames type are included in the cache key and in requests that\n\t\t\t\t\tCloudFront sends to the origin.
\n allExcept \u2013 All cookies in viewer requests are included in the cache key and\n\t\t\t\t\tin requests that CloudFront sends to the origin, \n except\n for those that are listed in the\n\t\t\t\t\tCookieNames type, which are not included.
\n all \u2013 All cookies in viewer requests are included in the cache key and in\n\t\t\t\t\trequests that CloudFront sends to the origin.
Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.
whitelist \u2013 Only the cookies in viewer requests that are listed in the CookieNames type are included in the cache key and in requests that CloudFront sends to the origin.
allExcept \u2013 All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except for those that are listed in the CookieNames type, which are not included.
all \u2013 All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and in requests that CloudFront sends to the origin.
" + "smithy.api#documentation": "An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#CachePolicyHeaderBehavior": { @@ -968,7 +968,7 @@ "HeaderBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyHeaderBehavior", "traits": { - "smithy.api#documentation": "Determines whether any HTTP headers are included in the cache key and in requests that CloudFront\n\t\t\tsends to the origin. Valid values are:
\n\n none \u2013 No HTTP headers are included in the cache key or in requests that CloudFront\n\t\t\t\t\tsends to the origin. Even when this field is set to none, any\n\t\t\t\t\theaders that are listed in an OriginRequestPolicy\n are included in origin requests.
\n whitelist \u2013 Only the HTTP headers that are listed in the Headers\n\t\t\t\t\ttype are included in the cache key and in requests that CloudFront sends to the\n\t\t\t\t\torigin.
Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.
whitelist \u2013 Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.
An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin the cache key and in requests that CloudFront sends to the origin.
" + "smithy.api#documentation": "An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#CachePolicyInUse": { @@ -988,7 +988,7 @@ } }, "traits": { - "smithy.api#documentation": "Cannot delete the cache policy because it is attached to one or more cache\n\t\t\tbehaviors.
", + "smithy.api#documentation": "Cannot delete the cache policy because it is attached to one or more cache behaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -999,7 +999,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing cache policies where you left off.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing cache policies where you left off.
Determines whether any URL query strings in viewer requests are included in the cache key\n\t\t\tand in requests that CloudFront sends to the origin. Valid values are:
\n\n none \u2013 No query strings in viewer requests are included in the cache key or\n\t\t\t\t\tin requests that CloudFront sends to the origin. Even when this field is set to\n\t\t\t\t\tnone, any query strings that are listed in an\n\t\t\t\t\tOriginRequestPolicy\n are included in origin\n\t\t\t\t\trequests.
\n whitelist \u2013 Only the query strings in viewer requests that are listed in the\n\t\t\t\t\tQueryStringNames type are included in the cache key and in requests\n\t\t\t\t\tthat CloudFront sends to the origin.
\n allExcept \u2013 All query strings in viewer requests are included in the cache\n\t\t\t\t\tkey and in requests that CloudFront sends to the origin, \n except\n those that are listed in the\n\t\t\t\t\tQueryStringNames type, which are not included.
\n all \u2013 All query strings in viewer requests are included in the cache key and\n\t\t\t\t\tin requests that CloudFront sends to the origin.
Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.
whitelist \u2013 Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.
allExcept \u2013 All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.
all \u2013 All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in the cache key and in requests that CloudFront sends to\n\t\t\tthe origin. The behavior depends on whether the QueryStringBehavior field\n\t\t\tin the CachePolicyQueryStringsConfig type is set to whitelist\n\t\t\t(the listed query strings \n are\n \n\t\t\tincluded) or allExcept (the listed query strings \n are not\n included, but all other query strings\n\t\t\tare).
Contains the specific query strings in viewer requests that either are or are not included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).
An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and in requests that CloudFront sends to the\n\t\t\torigin.
" + "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#CachePolicySummary": { @@ -1083,7 +1083,7 @@ "Type": { "target": "com.amazonaws.cloudfront#CachePolicyType", "traits": { - "smithy.api#documentation": "The type of cache policy, either managed (created by Amazon Web Services) or\n\t\t\t\tcustom (created in this Amazon Web Services account).
The type of cache policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
The number of HTTP methods for which you want CloudFront to cache responses. Valid values\n\t\t\tare 2 (for caching responses to GET and HEAD\n\t\t\trequests) and 3 (for caching responses to GET,\n\t\t\t\tHEAD, and OPTIONS requests).
The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).
A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto. Valid values for CachedMethods include GET, HEAD, and OPTIONS, depending on which caching option you choose. For more information, see the preceding section.
A complex type that contains the HTTP methods that you want CloudFront to cache responses to. Valid values for CachedMethods include GET, HEAD, and OPTIONS, depending on which caching option you choose. For more information, see the preceding section.
A complex type that controls whether CloudFront caches the response to requests using the\n\t\t\tspecified HTTP methods. There are two choices:
\nCloudFront caches responses to GET and HEAD\n\t\t\t\t\trequests.
CloudFront caches responses to GET, HEAD, and\n\t\t\t\t\t\tOPTIONS requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward\n\t\t\tAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for\n\t\t\tthe responses to be cached correctly.
" + "smithy.api#documentation": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:
CloudFront caches responses to GET and HEAD requests.
CloudFront caches responses to GET, HEAD, and OPTIONS requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
" } }, "com.amazonaws.cloudfront#CannotChangeImmutablePublicKeyFields": { @@ -1247,14 +1247,14 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ID for the origin access identity, for example, E74FTE3AJFJ256A.\n\t\t
The ID for the origin access identity, for example, E74FTE3AJFJ256A.
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin\n\t\t\taccess identity read permission to an object in Amazon S3.
", + "smithy.api#documentation": "The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
", "smithy.api#required": {} } }, @@ -1277,7 +1277,7 @@ } }, "traits": { - "smithy.api#documentation": "If the CallerReference is a value you already sent in a previous request\n\t\t\tto create an identity but the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original\n\t\t\trequest, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n\t\t
If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.
\nIf the value of CallerReference is new (regardless of the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig object), a new origin access\n\t\t\tidentity is created.
If the CallerReference is a value already sent in a previous identity\n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig is\n\t\t\tidentical to the original request (ignoring white space), the response includes the same\n\t\t\tinformation returned to the original request.
If the CallerReference is a value you already sent in a previous request\n\t\t\tto create an identity, but the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original\n\t\t\trequest, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n\t\t
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.
If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
A comment to describe the origin access identity. The comment cannot be longer than\n\t\t\t128 characters.
", + "smithy.api#documentation": "A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Origin access identity configuration. Send a GET request to the\n\t\t\t\t\t/CloudFront API version/CloudFront/identity ID/config\n\t\t\tresource.
Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.
Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour origin access identities where they left off.
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.
A flag that indicates whether more origin access identities remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more items in the list.
A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.
The number of CloudFront origin access identities that were created by the current\n\t\t\tAmazon Web Services account.
", + "smithy.api#documentation": "The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummaryList", "traits": { - "smithy.api#documentation": "A complex type that contains one CloudFrontOriginAccessIdentitySummary\n\t\t\telement for each origin access identity that was created by the current\n\t\t\tAmazon Web Services account.
A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current Amazon Web Services account.
Lists the origin access identities for CloudFront.Send a GET request to the\n\t\t\t\t\t/CloudFront API\n\t\t\t\tversion/origin-access-identity/cloudfront resource. The response\n\t\t\tincludes a CloudFrontOriginAccessIdentityList element with zero or more\n\t\t\t\tCloudFrontOriginAccessIdentitySummary child elements. By default, your\n\t\t\tentire list of origin access identities is returned in one single page. If the list is\n\t\t\tlong, you can paginate it using the MaxItems and Marker\n\t\t\tparameters.
Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.
The ID for the origin access identity. For example:\n\t\t\tE74FTE3AJFJ256A.
The ID for the origin access identity. For example: E74FTE3AJFJ256A.
The Amazon S3 canonical user ID for the origin access identity, which you use when giving\n\t\t\tthe origin access identity read permission to an object in Amazon S3.
", + "smithy.api#documentation": "The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The comment for this origin access identity, as originally specified when\n\t\t\tcreated.
", + "smithy.api#documentation": "The comment for this origin access identity, as originally specified when created.
", "smithy.api#required": {} } } @@ -1861,7 +1861,7 @@ "name": "cloudfront" }, "aws.protocols#restXml": {}, - "smithy.api#documentation": "This is the Amazon CloudFront API Reference. This guide is for developers\n\t\t\twho need detailed information about CloudFront API actions, data types, and errors. For\n\t\t\tdetailed information about CloudFront features, see the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
", "smithy.api#title": "Amazon CloudFront", "smithy.api#xmlNamespace": { "uri": "http://cloudfront.amazonaws.com/doc/2020-05-31/" @@ -2766,12 +2766,12 @@ "AccountId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The (partially hidden) ID of the Amazon Web Services account that owns the distribution that's\n\t\t\tassociated with the alias.
" + "smithy.api#documentation": "The (partially hidden) ID of the Amazon Web Services account that owns the distribution that's associated with the alias.
" } } }, "traits": { - "smithy.api#documentation": "An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that\n\t\t\tit's associated with. The distribution and account IDs are partially hidden, which\n\t\t\tallows you to identify the distributions and accounts that you own, but helps to protect\n\t\t\tthe information of ones that you don't own.
" + "smithy.api#documentation": "An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it's associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
" } }, "com.amazonaws.cloudfront#ConflictingAliases": { @@ -2789,7 +2789,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing conflicting aliases where you left off.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing conflicting aliases where you left off.
A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts\n\t\t\tthat they are associated with. In the list, the distribution and account IDs are\n\t\t\tpartially hidden, which allows you to identify the distributions and accounts that you\n\t\t\town, but helps to protect the information of ones that you don't own.
" + "smithy.api#documentation": "A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
" } }, "com.amazonaws.cloudfront#ConnectionGroup": { @@ -3047,7 +3047,7 @@ "ForwardWhenContentTypeIsUnknown": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "The setting in a field-level encryption content type-profile mapping that specifies\n\t\t\twhat to do when an unknown content type is provided for the profile. If true, content is\n\t\t\tforwarded without being encrypted when the content type is unknown. If false (the\n\t\t\tdefault), an error is returned when the content type is unknown.
", + "smithy.api#documentation": "The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
", "smithy.api#required": {} } }, @@ -3139,21 +3139,21 @@ "StagingDistributionDnsNames": { "target": "com.amazonaws.cloudfront#StagingDistributionDnsNames", "traits": { - "smithy.api#documentation": "The CloudFront domain name of the staging distribution. For example:\n\t\t\t\td111111abcdef8.cloudfront.net.
The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
A Boolean that indicates whether this continuous deployment policy is enabled (in\n\t\t\teffect). When this value is true, this policy is enabled and in effect.\n\t\t\tWhen this value is false, this policy is not enabled and has no\n\t\t\teffect.
A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
Contains the parameters for routing production traffic from your primary to staging\n\t\t\tdistributions.
" + "smithy.api#documentation": "Contains the parameters for routing production traffic from your primary to staging distributions.
" } } }, @@ -3169,7 +3169,7 @@ } }, "traits": { - "smithy.api#documentation": "You cannot delete a continuous deployment policy that is associated with a primary\n\t\t\tdistribution.
", + "smithy.api#documentation": "You cannot delete a continuous deployment policy that is associated with a primary distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3180,20 +3180,20 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Indicates the next page of continuous deployment policies. To get the next page of the\n\t\t\tlist, use this value in the Marker field of your request.
Indicates the next page of continuous deployment policies. To get the next page of the list, use this value in the Marker field of your request.
The maximum number of continuous deployment policies that were specified in your\n\t\t\trequest.
", + "smithy.api#documentation": "The maximum number of continuous deployment policies that were specified in your request.
", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The total number of continuous deployment policies in your Amazon Web Services account, regardless\n\t\t\tof the MaxItems value.
The total number of continuous deployment policies in your Amazon Web Services account, regardless of the MaxItems value.
The request header name that you want CloudFront to send to your staging\n\t\t\tdistribution. The header must contain the prefix aws-cf-cd-.
The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
This configuration determines which HTTP requests are sent to the staging\n\t\t\tdistribution. If the HTTP request contains a header and value that matches what you\n\t\t\tspecify here, the request is sent to the staging distribution. Otherwise the request is\n\t\t\tsent to the primary distribution.
" + "smithy.api#documentation": "This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
" } }, "com.amazonaws.cloudfront#ContinuousDeploymentSingleWeightConfig": { @@ -3277,7 +3277,7 @@ "Weight": { "target": "com.amazonaws.cloudfront#float", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to a staging distribution, expressed as a decimal\n\t\t\tnumber between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
", + "smithy.api#documentation": "The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
", "smithy.api#required": {} } }, @@ -3325,19 +3325,19 @@ "Forward": { "target": "com.amazonaws.cloudfront#ItemSelection", "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send cookies to the origin but not include them in the cache key, use\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nSpecifies which cookies to forward to the origin for this cache behavior: all, none,\n\t\t\tor the list of cookies specified in the WhitelistedNames complex\n\t\t\ttype.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an\n\t\t\tAmazon S3 origin, specify none for the Forward element.
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.
This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nRequired if you specify whitelist for the value of Forward.\n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the\n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names\n\t\t\tof those cookies.
If you specify all or none for the value of\n\t\t\t\tForward, omit WhitelistedNames. If you change the value of\n\t\t\t\tForward from whitelist to all or\n\t\t\t\tnone and you don't delete the WhitelistedNames element and\n\t\t\tits child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each\n\t\t\tcache behavior, see CloudFront\n\t\t\t\tLimits in the Amazon Web Services General Reference.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.
" } } }, "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include cookies in the cache key, use CookiesConfig in a\n\t\t\tcache policy. See CachePolicy.
If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\t\tCookiesConfig in an origin request policy. See\n\t\t\t\tOriginRequestPolicy.
A complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\t\tCaching Content Based on\n\t\t\t\tCookies in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy.
If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy.
A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CopyDistribution": { @@ -3543,7 +3543,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a staging distribution using the configuration of the provided primary\n\t\t\tdistribution. A staging distribution is a copy of an existing distribution (called the\n\t\t\tprimary distribution) that you can use in a continuous deployment workflow.
\nAfter you create a staging distribution, you can use UpdateDistribution\n\t\t\tto modify the staging distribution's configuration. Then you can use\n\t\t\t\tCreateContinuousDeploymentPolicy to incrementally move traffic to the\n\t\t\tstaging distribution.
This API operation requires the following IAM permissions:
\n\n GetDistribution\n
\n\n CreateDistribution\n
\n\n CopyDistribution\n
\nCreates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use UpdateDistribution to modify the staging distribution's configuration. Then you can use CreateContinuousDeploymentPolicy to incrementally move traffic to the staging distribution.
This API operation requires the following IAM permissions:
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{PrimaryDistributionId}/copy", @@ -3557,7 +3557,7 @@ "PrimaryDistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of the primary distribution whose configuration you are copying. To get\n\t\t\ta distribution ID, use ListDistributions.
The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use ListDistributions.
The type of distribution that your primary distribution will be copied to. The only\n\t\t\tvalid value is True, indicating that you are copying to a staging\n\t\t\tdistribution.
The type of distribution that your primary distribution will be copied to. The only valid value is True, indicating that you are copying to a staging distribution.
The version identifier of the primary distribution whose configuration you are\n\t\t\tcopying. This is the ETag value returned in the response to\n\t\t\t\tGetDistribution and GetDistributionConfig.
The version identifier of the primary distribution whose configuration you are copying. This is the ETag value returned in the response to GetDistribution and GetDistributionConfig.
A value that uniquely identifies a request to create a resource. This helps to prevent\n\t\t\tCloudFront from creating a duplicate resource if you accidentally resubmit an identical\n\t\t\trequest.
", + "smithy.api#documentation": "A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request.
", "smithy.api#required": {} } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean flag to specify the state of the staging distribution when it's\n\t\t\tcreated. When you set this value to True, the staging\n\t\t\tdistribution is enabled. When you set this value to False, the\n\t\t\tstaging distribution is disabled.
If you omit this field, the default value is True.
A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to True, the staging distribution is enabled. When you set this value to False, the staging distribution is disabled.
If you omit this field, the default value is True.
Creates a cache policy.
\nAfter you create a cache policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it's attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:
\nThe values that CloudFront includes in the cache key. These\n\t\t\t\t\tvalues can include HTTP headers, cookies, and URL query strings. CloudFront uses the\n\t\t\t\t\tcache key to find an object in its cache that it can return to the\n\t\t\t\t\tviewer.
\nThe default, minimum, and maximum time to live (TTL) values that you want\n\t\t\t\t\tobjects to stay in the CloudFront cache.
\nThe headers, cookies, and query strings that are included in the cache key are also included\n\t\t\tin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an\n\t\t\tobject in its cache that matches the request's cache key. If you want to send values to\n\t\t\tthe origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.
For more information about cache policies, see Controlling the cache key in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/cache-policy", @@ -3821,7 +3821,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new origin access identity. If you're using Amazon S3 for your origin, you can\n\t\t\tuse an origin access identity to require users to access your content using a CloudFront URL\n\t\t\tinstead of the Amazon S3 URL. For more information about how to use origin access identities,\n\t\t\tsee Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-access-identity/cloudfront", @@ -3843,7 +3843,7 @@ } }, "traits": { - "smithy.api#documentation": "The request to create a new origin access identity (OAI). An origin access identity is\n\t\t\ta special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all\n\t\t\tor just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in\n\t\t\tthe Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.
", "smithy.api#input": {} } }, @@ -3927,7 +3927,7 @@ "Ipv6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the \n \tAmazon CloudFront Developer Guide.
Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
Creates a continuous deployment policy that distributes traffic for a custom domain\n\t\t\tname to two different CloudFront distributions.
\nTo use a continuous deployment policy, first use CopyDistribution to\n\t\t\tcreate a staging distribution, then use UpdateDistribution to modify the\n\t\t\tstaging distribution's configuration.
After you create and update a staging distribution, you can use a continuous\n\t\t\tdeployment policy to incrementally move traffic to the staging distribution. This\n\t\t\tworkflow enables you to test changes to a distribution's configuration before moving all\n\t\t\tof your domain's production traffic to the new configuration.
", + "smithy.api#documentation": "Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution to create a staging distribution, then use UpdateDistribution to modify the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/continuous-deployment-policy", @@ -4046,7 +4046,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.
", + "smithy.api#documentation": "The version identifier for the current version of the continuous deployment policy.
", "smithy.api#httpHeader": "ETag" } } @@ -4663,7 +4663,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new distribution with tags. This API operation requires the following IAM\n\t\t\tpermissions:
\n\n CreateDistribution\n
\n\n TagResource\n
\nCreate a new distribution with tags. This API operation requires the following IAM permissions:
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution?WithTags", @@ -4799,7 +4799,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
The current version of the field level encryption profile. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
Creates a CloudFront function.
\nTo create a function, you provide the function code and some configuration information\n\t\t\tabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\n\t\t\tidentifies the function.
\nWhen you create a function, it's in the DEVELOPMENT stage. In this stage,\n\t\t\tyou can test the function with TestFunction, and update it with\n\t\t\t\tUpdateFunction.
When you're ready to use your function with a CloudFront distribution, use\n\t\t\t\tPublishFunction to copy the function from the DEVELOPMENT\n\t\t\tstage to LIVE. When it's live, you can attach the function to a\n\t\t\tdistribution's cache behavior, using the function's ARN.
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction, and update it with UpdateFunction.
When you're ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN.
Configuration information about the function, including an optional comment and the\n\t\t\tfunction's runtime.
", + "smithy.api#documentation": "Configuration information about the function, including an optional comment and the function's runtime.
", "smithy.api#required": {} } }, "FunctionCode": { "target": "com.amazonaws.cloudfront#FunctionBlob", "traits": { - "smithy.api#documentation": "The function code. For more information about writing a CloudFront function, see Writing\n\t\t\t\tfunction code for CloudFront Functions in the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } @@ -5021,7 +5021,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The URL of the CloudFront function. Use the URL to manage the function with the CloudFront\n\t\t\tAPI.
", + "smithy.api#documentation": "The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
", "smithy.api#httpHeader": "Location" } }, @@ -5194,7 +5194,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The fully qualified URI of the distribution and invalidation batch request, including\n\t\t\tthe Invalidation ID.
The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
\nTo create a key group, you must specify at least one public key for the key group.\n\t\t\tAfter you create a key group, you can reference it from one or more cache behaviors.\n\t\t\tWhen you reference a key group in a cache behavior, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/key-group", @@ -5357,7 +5357,7 @@ "Name": { "target": "com.amazonaws.cloudfront#KeyValueStoreName", "traits": { - "smithy.api#documentation": "The name of the key value store. The minimum length is 1 character and the maximum length is\n\t\t\t64 characters.
", + "smithy.api#documentation": "The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters.
", "smithy.api#required": {} } }, @@ -5430,7 +5430,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The\n\t\t\tadditional metrics incur an additional cost.
\nFor more information, see Viewing additional CloudFront distribution metrics in\n\t\t\tthe Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -5452,7 +5452,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional CloudWatch\n\t\t\tmetrics are enabled for a given CloudFront distribution.
", + "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "MonitoringSubscription" @@ -5469,7 +5469,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.
", + "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {} } } @@ -5498,7 +5498,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new origin access control in CloudFront. After you create an origin access\n\t\t\tcontrol, you can add it to an origin in a CloudFront distribution so that CloudFront sends\n\t\t\tauthenticated (signed) requests to the origin.
\nThis makes it possible to block public access to the origin, allowing viewers (users) to\n\t\t\taccess the origin's content only through CloudFront.
\nFor more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-access-control", @@ -5587,7 +5587,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an origin request policy.
\nAfter you create an origin request policy, you can attach it to one or more cache\n\t\t\tbehaviors. When it's attached to a cache behavior, the origin request policy determines\n\t\t\tthe values that CloudFront includes in requests that it sends to the origin. Each request that\n\t\t\tCloudFront sends to the origin includes the following:
\nThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\nThe headers that CloudFront automatically includes in every origin request,\n\t\t\t\t\tincluding Host, User-Agent, and\n\t\t\t\t\t\tX-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the\n\t\t\t\t\tcache policy or the origin request policy. These can include items from the\n\t\t\t\t\tviewer request and, in the case of headers, additional ones that are added by\n\t\t\t\t\tCloudFront.
\nCloudFront sends a request when it can't find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.
For more information about origin request policies, see Controlling origin requests in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-request-policy", @@ -5738,7 +5738,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a real-time log configuration.
\nAfter you create a real-time log configuration, you can attach it to one or more cache\n\t\t\tbehaviors to send real-time log data to the specified Amazon Kinesis data stream.
\nFor more information about real-time log configurations, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/realtime-log-config", @@ -5752,14 +5752,14 @@ "EndPoints": { "target": "com.amazonaws.cloudfront#EndPointList", "traits": { - "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
", + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
", "smithy.api#required": {} } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "A list of fields to include in each real-time log record.
\nFor more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, @@ -5831,7 +5831,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a response headers policy.
\nA response headers policy contains information about a set of HTTP headers. To create a\n\t\t\tresponse headers policy, you provide some metadata about the policy and a set of\n\t\t\tconfigurations that specify the headers.
\nAfter you create a response headers policy, you can use its ID to attach it to one or more\n\t\t\tcache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the\n\t\t\tresponse headers policy affects the HTTP headers that CloudFront includes in HTTP responses to\n\t\t\trequests that match the cache behavior. CloudFront adds or removes response headers according\n\t\t\tto the configuration of the response headers policy.
\nFor more information, see Adding or removing HTTP headers in CloudFront responses in the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/response-headers-policy", @@ -5845,7 +5845,7 @@ "ResponseHeadersPolicyConfig": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyConfig", "traits": { - "smithy.api#documentation": "Contains metadata about the response headers policy, and a set of configurations that\n\t\t\tspecify the HTTP headers.
", + "smithy.api#documentation": "Contains metadata about the response headers policy, and a set of configurations that specify the HTTP headers.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "ResponseHeadersPolicyConfig" @@ -5935,7 +5935,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP)\n\t\t\tdistributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion\n\t\t\tforum.
", + "smithy.api#documentation": "This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution", @@ -5974,7 +5974,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just\n\t\t\tcreated.
", + "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, @@ -6044,7 +6044,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP)\n\t\t\tdistributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion\n\t\t\tforum.
", + "smithy.api#documentation": "This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution?WithTags", @@ -6083,7 +6083,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just\n\t\t\tcreated.
", + "smithy.api#documentation": "The fully qualified URI of the new streaming distribution resource just created.
", "smithy.api#httpHeader": "Location" } }, @@ -6240,31 +6240,31 @@ "ErrorCode": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The HTTP status code for which you want to specify a custom error page and/or a\n\t\t\tcaching duration.
", + "smithy.api#documentation": "The HTTP status code for which you want to specify a custom error page and/or a caching duration.
", "smithy.api#required": {} } }, "ResponsePagePath": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The path to the custom error page that you want CloudFront to return to a viewer when your\n\t\t\torigin returns the HTTP status code specified by ErrorCode, for example,\n\t\t\t\t/4xx-errors/403-forbidden.html. If you want to store your objects and\n\t\t\tyour custom error pages in different locations, your distribution must include a cache\n\t\t\tbehavior for which the following is true:
The value of PathPattern matches the path to your custom error\n\t\t\t\t\tmessages. For example, suppose you saved custom error pages for 4xx errors in an\n\t\t\t\t\tAmazon S3 bucket in a directory named /4xx-errors. Your distribution\n\t\t\t\t\tmust include a cache behavior for which the path pattern routes requests for\n\t\t\t\t\tyour custom error pages to that location, for example,\n\t\t\t\t\t\t/4xx-errors/*.
The value of TargetOriginId specifies the value of the\n\t\t\t\t\t\tID element for the origin that contains your custom error\n\t\t\t\t\tpages.
If you specify a value for ResponsePagePath, you must also specify a\n\t\t\tvalue for ResponseCode.
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom\n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get\n\t\t\tthe files that you want to return to viewers because the origin server is\n\t\t\tunavailable.
" + "smithy.api#documentation": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:
The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.
The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.
If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode.
We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.
" } }, "ResponseCode": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The HTTP status code that you want CloudFront to return to the viewer along with the custom\n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status\n\t\t\tcode different from the status code that your origin returned to CloudFront, for\n\t\t\texample:
\nSome Internet devices (some firewalls and corporate proxies, for example)\n\t\t\t\t\tintercept HTTP 4xx and 5xx and prevent the response from being returned to the\n\t\t\t\t\tviewer. If you substitute 200, the response typically won't be\n\t\t\t\t\tintercepted.
If you don't care about distinguishing among different client errors or server\n\t\t\t\t\terrors, you can specify 400 or 500 as the\n\t\t\t\t\t\tResponseCode for all 4xx or 5xx errors.
You might want to return a 200 status code (OK) and static\n\t\t\t\t\twebsite so your customers don't know that your website is down.
If you specify a value for ResponseCode, you must also specify a value\n\t\t\tfor ResponsePagePath.
The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:
Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.
If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.
You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.
If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath.
The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status\n\t\t\tcode specified in ErrorCode. When this time period has elapsed, CloudFront\n\t\t\tqueries your origin to see whether the problem that caused the error has been resolved\n\t\t\tand the requested object is now available.
For more information, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.
For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "A complex type that controls:
\nWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom\n\t\t\t\t\terror messages before returning the response to the viewer.
\nHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\nFor more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CustomErrorResponseList": { @@ -6282,19 +6282,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of HTTP status codes for which you want to specify a custom error page\n\t\t\tand/or a caching duration. If Quantity is 0, you can omit\n\t\t\t\tItems.
The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.
A complex type that contains a CustomErrorResponse element for each HTTP\n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration.\n\t\t
A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
A complex type that controls:
\nWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom\n\t\t\t\t\terror messages before returning the response to the viewer.
\nHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\nFor more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that controls:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CustomHeaders": { @@ -6310,7 +6310,7 @@ "Items": { "target": "com.amazonaws.cloudfront#OriginCustomHeadersList", "traits": { - "smithy.api#documentation": "\n Optional: A list that contains one\n\t\t\t\tOriginCustomHeader element for each custom header that you want CloudFront to\n\t\t\tforward to the origin. If Quantity is 0, omit Items.
Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.
The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the\n\t\t\torigin listens on.
", + "smithy.api#documentation": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.
", "smithy.api#required": {} } }, "HTTPSPort": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that\n\t\t\tthe origin listens on.
", + "smithy.api#documentation": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.
", "smithy.api#required": {} } }, "OriginProtocolPolicy": { "target": "com.amazonaws.cloudfront#OriginProtocolPolicy", "traits": { - "smithy.api#documentation": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid\n\t\t\tvalues are:
\n\n http-only \u2013 CloudFront always uses HTTP to connect to the\n\t\t\t\t\torigin.
\n match-viewer \u2013 CloudFront connects to the origin using the same\n\t\t\t\t\tprotocol that the viewer used to connect to CloudFront.
\n https-only \u2013 CloudFront always uses HTTPS to connect to the\n\t\t\t\t\torigin.
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:
http-only \u2013 CloudFront always uses HTTP to connect to the origin.
match-viewer \u2013 CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
https-only \u2013 CloudFront always uses HTTPS to connect to the origin.
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin\n\t\t\tover HTTPS. Valid values include SSLv3, TLSv1,\n\t\t\t\tTLSv1.1, and TLSv1.2.
For more information, see Minimum Origin SSL Protocol in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.
For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.
" } }, "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is\n\t\t\talso known as the origin response timeout. The minimum timeout is 1\n\t\t\tsecond, the maximum is 60 seconds, and the default (if you don't specify otherwise) is\n\t\t\t30 seconds.
\nFor more information, see Response timeout (custom origins only) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
For more information, see Response timeout (custom origins only) in the Amazon CloudFront Developer Guide.
" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The\n\t\t\tminimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't\n\t\t\tspecify otherwise) is 5 seconds.
\nFor more information, see Keep-alive timeout (custom origins only) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.
For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "A custom origin. A custom origin is any origin that is not an\n\t\t\tAmazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n\t\t\t\tstatic website hosting\n is a custom origin.
" + "smithy.api#documentation": "A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.
" } }, "com.amazonaws.cloudfront#CustomizationActionType": { @@ -6414,26 +6414,26 @@ "TargetOriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of ID for the origin that you want CloudFront to route requests to\n\t\t\twhen they use the default cache behavior.
The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.
We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or\n\t\t\tsigned cookies.
\nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The\n\t\t\tsigned URL or cookie contains information about which public key CloudFront should use to\n\t\t\tverify the signature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { - "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.
\nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { - "smithy.api#documentation": "The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:
\n allow-all: Viewers can use HTTP or HTTPS.
\n redirect-to-https: If a viewer submits an HTTP request, CloudFront\n\t\t\t\t\treturns an HTTP status code of 301 (Moved Permanently) to the viewer along with\n\t\t\t\t\tthe HTTPS URL. The viewer then resubmits the request using the new URL.
\n https-only: If a viewer sends an HTTP request, CloudFront returns an\n\t\t\t\t\tHTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nThe only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.
\nThe protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:
allow-all: Viewers can use HTTP or HTTPS.
redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming\n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify\n\t\t\t\ttrue; if not, specify false. If you specify\n\t\t\t\ttrue for SmoothStreaming, you can still distribute other\n\t\t\tcontent using this cache behavior if the content matches the value of\n\t\t\t\tPathPattern.
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior.\n\t\t\tIf so, specify true; if not, specify false. For more\n\t\t\tinformation, see Serving\n\t\t\t\tCompressed Files in the Amazon CloudFront Developer Guide.
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
A complex type that contains zero or more Lambda@Edge function associations for a\n\t\t\tcache behavior.
" + "smithy.api#documentation": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { - "smithy.api#documentation": "A list of CloudFront functions that are associated with this cache behavior. Your functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.
A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the LIVE stage to associate them with a cache behavior.
The value of ID for the field-level encryption configuration that you\n\t\t\twant CloudFront to use for encrypting specific fields of data for the default cache\n\t\t\tbehavior.
The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to\n\t\t\tthis cache behavior. For more information, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.
" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The unique identifier of the cache policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nA DefaultCacheBehavior must include either a CachePolicyId\n\t\t\tor ForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.
The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
The unique identifier of the origin request policy that is attached to the default\n\t\t\tcache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
" } }, "ResponseHeadersPolicyId": { @@ -6504,33 +6504,33 @@ "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nA DefaultCacheBehavior must include either a CachePolicyId\n\t\t\tor ForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.
A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "This field is deprecated. We recommend that you use the MinTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. For more information, see Managing How Long\n\t\t\t\tContent Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nYou must specify 0 for MinTTL if you configure CloudFront to\n\t\t\tforward all headers to your origin (under Headers, if you specify\n\t\t\t\t1 for Quantity and * for\n\t\t\tName).
This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).
This field is deprecated. We recommend that you use the DefaultTTL field\n\t\t\tin a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin does not add HTTP\n\t\t\theaders such as Cache-Control max-age, Cache-Control s-maxage,\n\t\t\tand Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin adds HTTP headers such\n\t\t\tas Cache-Control max-age, Cache-Control s-maxage, and\n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if request URLs don't match any of the values\n\t\t\tof PathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.
A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
The current version (ETag value) of the Anycast static IP list that\n\t\t\tyou are deleting.
The current version (ETag value) of the Anycast static IP list that you are deleting.
Deletes a cache policy.
\nYou cannot delete a cache policy if it's attached to a cache behavior. First update\n\t\t\tyour distributions to remove the cache policy from all cache behaviors, then delete the\n\t\t\tcache policy.
\nTo delete a cache policy, you must provide the policy's identifier and version. To get\n\t\t\tthese values, you can use ListCachePolicies or\n\t\t\tGetCachePolicy.
Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy's identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy.
The unique identifier for the cache policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListCachePolicies.
The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies.
The version of the cache policy that you are deleting. The version is the cache\n\t\t\tpolicy's ETag value, which you can get using\n\t\t\tListCachePolicies, GetCachePolicy, or\n\t\t\t\tGetCachePolicyConfig.
The version of the cache policy that you are deleting. The version is the cache policy's ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig.
The value of the ETag header you received from a previous\n\t\t\t\tGET or PUT request. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
Deletes a continuous deployment policy.
\nYou cannot delete a continuous deployment policy that's attached to a primary\n\t\t\tdistribution. First update your distribution to remove the continuous deployment policy,\n\t\t\tthen you can delete the policy.
", + "smithy.api#documentation": "Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/continuous-deployment-policy/{Id}", @@ -6830,7 +6830,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version (ETag value) of the continuous deployment policy that\n\t\t\tyou are deleting.
The current version (ETag value) of the continuous deployment policy that you are deleting.
The value of the ETag header that you received when you disabled the\n\t\t\tdistribution. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
This action deletes a web distribution. To delete a web distribution using the CloudFront\n\t\t\tAPI, perform the following steps.
\n\n To delete a web distribution using the CloudFront API:\n
\nDisable the web distribution
\nSubmit a GET Distribution Config request to get the current\n\t\t\t\t\tconfiguration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tDistribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.
Submit a PUT Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 2.
Review the response to the PUT Distribution Config request to\n\t\t\t\t\tconfirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes\n\t\t\t\t\thave propagated. When propagation is complete, the value of Status\n\t\t\t\t\tis Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 6.
Review the response to your DELETE Distribution request to\n\t\t\t\t\tconfirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.
Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.
Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.
Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#input": {} } }, @@ -6926,7 +6926,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.
\nTo delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.
Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.
To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.
The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the\n\t\t\tGetDistributionTenant API operation.
The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The value of the ETag header that you received when retrieving the\n\t\t\tconfiguration identity to delete. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the\n\t\t\tprofile to delete. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.
Deletes a CloudFront function.
\nYou cannot delete a function if it's associated with a cache behavior. First, update\n\t\t\tyour distributions to remove the function association from all cache behaviors, then\n\t\t\tdelete the function.
\nTo delete a function, you must provide the function's name and version\n\t\t\t\t(ETag value). To get these values, you can use\n\t\t\t\tListFunctions and DescribeFunction.
Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction.
The current version (ETag value) of the function that you are deleting,\n\t\t\twhich you can get using DescribeFunction.
The current version (ETag value) of the function that you are deleting, which you can get using DescribeFunction.
Deletes a key group.
\nYou cannot delete a key group that is referenced in a cache behavior. First update\n\t\t\tyour distributions to remove the key group from all cache behaviors, then delete the key\n\t\t\tgroup.
\nTo delete a key group, you must provide the key group's identifier and version. To get\n\t\t\tthese values, use ListKeyGroups followed by GetKeyGroup or\n\t\t\t\tGetKeyGroupConfig.
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group's identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig.
The identifier of the key group that you are deleting. To get the identifier, use\n\t\t\t\tListKeyGroups.
The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups.
The version of the key group that you are deleting. The version is the key group's\n\t\t\t\tETag value. To get the ETag, use GetKeyGroup\n\t\t\tor GetKeyGroupConfig.
The version of the key group that you are deleting. The version is the key group's ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig.
Deletes a CloudFront origin access control.
\nYou cannot delete an origin access control if it's in use. First, update all\n\t\t\tdistributions to remove the origin access control from all origins, then delete the\n\t\t\torigin access control.
", + "smithy.api#documentation": "Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/origin-access-control/{Id}", @@ -7358,7 +7358,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version (ETag value) of the origin access control that you\n\t\t\tare deleting.
The current version (ETag value) of the origin access control that you are deleting.
Deletes an origin request policy.
\nYou cannot delete an origin request policy if it's attached to any cache behaviors.\n\t\t\tFirst update your distributions to remove the origin request policy from all cache\n\t\t\tbehaviors, then delete the origin request policy.
\nTo delete an origin request policy, you must provide the policy's identifier and\n\t\t\tversion. To get the identifier, you can use ListOriginRequestPolicies or\n\t\t\t\tGetOriginRequestPolicy.
Deletes an origin request policy.
You cannot delete an origin request policy if it's attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy's identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy.
The unique identifier for the origin request policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListOriginRequestPolicies.
The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies.
The version of the origin request policy that you are deleting. The version is the\n\t\t\torigin request policy's ETag value, which you can get using\n\t\t\t\tListOriginRequestPolicies, GetOriginRequestPolicy, or\n\t\t\t\tGetOriginRequestPolicyConfig.
The version of the origin request policy that you are deleting. The version is the origin request policy's ETag value, which you can get using ListOriginRequestPolicies, GetOriginRequestPolicy, or GetOriginRequestPolicyConfig.
The value of the ETag header that you received when retrieving the public\n\t\t\tkey identity to delete. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.
Deletes a real-time log configuration.
\nYou cannot delete a real-time log configuration if it's attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the real-time log configuration from all cache\n\t\t\tbehaviors, then delete the real-time log configuration.
\nTo delete a real-time log configuration, you can provide the configuration's name or\n\t\t\tits Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to delete.
", + "smithy.api#documentation": "Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/delete-realtime-log-config", @@ -7564,7 +7564,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a response headers policy.
\nYou cannot delete a response headers policy if it's attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the response headers policy from all cache\n\t\t\tbehaviors, then delete the response headers policy.
\nTo delete a response headers policy, you must provide the policy's identifier and\n\t\t\tversion. To get these values, you can use ListResponseHeadersPolicies or\n\t\t\t\tGetResponseHeadersPolicy.
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use ListResponseHeadersPolicies or GetResponseHeadersPolicy.
The identifier for the response headers policy that you are deleting.
\nTo get the identifier, you can use ListResponseHeadersPolicies.
The identifier for the response headers policy that you are deleting.
To get the identifier, you can use ListResponseHeadersPolicies.
The version of the response headers policy that you are deleting.
\nThe version is the response headers policy's ETag value, which you can\n\t\t\tget using ListResponseHeadersPolicies,\n\t\t\t\tGetResponseHeadersPolicy, or\n\t\t\t\tGetResponseHeadersPolicyConfig.
The version of the response headers policy that you are deleting.
The version is the response headers policy's ETag value, which you can get using ListResponseHeadersPolicies, GetResponseHeadersPolicy, or GetResponseHeadersPolicyConfig.
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API,\n\t\t\tperform the following steps.
\n\n To delete an RTMP distribution using the CloudFront\n\t\t\tAPI:
\nDisable the RTMP distribution.
\nSubmit a GET Streaming Distribution Config request to get the\n\t\t\t\t\tcurrent configuration and the Etag header for the distribution.\n\t\t\t\t
Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tStreaming Distribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.
Submit a PUT Streaming Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Then set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Streaming Distribution\n\t\t\t\t\t\tConfig request in Step 2.
Review the response to the PUT Streaming Distribution Config\n\t\t\t\t\trequest to confirm that the distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm\n\t\t\t\t\tthat your changes have propagated. When propagation is complete, the value of\n\t\t\t\t\t\tStatus is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of\n\t\t\t\t\tthe HTTP If-Match header to the value of the ETag\n\t\t\t\t\theader that CloudFront returned when you submitted the GET Streaming\n\t\t\t\t\t\tDistribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request\n\t\t\t\t\tto confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.
Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/streaming-distribution/{Id}", @@ -7643,7 +7643,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of the ETag header that you received when you disabled the\n\t\t\tstreaming distribution. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.
Gets configuration information and metadata about a CloudFront function, but not the\n\t\t\tfunction's code. To get a function's code, use GetFunction.
To get configuration information and metadata about a function, you must provide the\n\t\t\tfunction's name and stage. To get these values, you can use\n\t\t\tListFunctions.
Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use GetFunction.
To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use ListFunctions.
The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the\n\t\t\t\tGetDistributionTenant API operation.
The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the GetDistributionTenant API operation.
The distribution's status. When the status is Deployed, the\n\t\t\tdistribution's information is fully propagated to all CloudFront edge locations.
The distribution's status. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.
The distribution's CloudFront domain name. For example:\n\t\t\td111111abcdef8.cloudfront.net.
The distribution's CloudFront domain name. For example: d111111abcdef8.cloudfront.net.
We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each\n\t\t\taccount that CloudFront can use to verify the signatures of signed URLs or signed\n\t\t\tcookies.
" + "smithy.api#documentation": "We recommend using TrustedKeyGroups instead of TrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" } }, "ActiveTrustedKeyGroups": { "target": "com.amazonaws.cloudfront#ActiveTrustedKeyGroups", "traits": { - "smithy.api#documentation": "This field contains a list of key groups and the public keys in each key group that\n\t\t\tCloudFront can use to verify the signatures of signed URLs or signed cookies.
" + "smithy.api#documentation": "This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" } }, "DistributionConfig": { @@ -8158,12 +8158,12 @@ "AliasICPRecordals": { "target": "com.amazonaws.cloudfront#AliasICPRecordals", "traits": { - "smithy.api#documentation": "Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions.
\nFor more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.
" + "smithy.api#documentation": "Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
" } } }, "traits": { - "smithy.api#documentation": "A distribution tells CloudFront where you want content to be delivered from, and the details\n\t\t\tabout how to track and manage content delivery.
" + "smithy.api#documentation": "A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
" } }, "com.amazonaws.cloudfront#DistributionAlreadyExists": { @@ -8174,7 +8174,7 @@ } }, "traits": { - "smithy.api#documentation": "The caller reference you attempted to create the distribution with is associated with\n\t\t\tanother distribution.
", + "smithy.api#documentation": "The caller reference you attempted to create the distribution with is associated with another distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -8185,20 +8185,20 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.
\nIf the value of CallerReference is new (regardless of the content of the\n\t\t\t\tDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request\n\t\t\tto create a distribution, CloudFront returns a DistributionAlreadyExists\n\t\t\terror.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.
" + "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
" } }, "DefaultRootObject": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "When a viewer requests the root URL for your distribution, the default root object is the\n\t\t\tobject that you want CloudFront to request from your origin. For example, if your root URL is\n\t\t\t\thttps://www.example.com, you can specify CloudFront to return the\n\t\t\t\tindex.html file as the default root object. You can specify a default\n\t\t\troot object so that viewers see a specific file or object, instead of another object in\n\t\t\tyour distribution (for example,\n\t\t\t\thttps://www.example.com/product-description.html). A default root\n\t\t\tobject avoids exposing the contents of your distribution.
You can specify the object name or a path to the object name (for example,\n\t\t\t\tindex.html or exampleFolderName/index.html). Your string\n\t\t\tcan't begin with a forward slash (/). Only specify the object name or the\n\t\t\tpath to the object.
If you don't want to specify a default root object when you create a distribution,\n\t\t\tinclude an empty DefaultRootObject element.
To delete the default root object from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty DefaultRootObject\n\t\t\telement.
To replace the default root object, update the distribution configuration and specify\n\t\t\tthe new object.
\nFor more information about the default root object, see Specify a default root object in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is https://www.example.com, you can specify CloudFront to return the index.html file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, https://www.example.com/product-description.html). A default root object avoids exposing the contents of your distribution.
You can specify the object name or a path to the object name (for example, index.html or exampleFolderName/index.html). Your string can't begin with a forward slash (/). Only specify the object name or the path to the object.
If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.
To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.
To replace the default root object, update the distribution configuration and specify the new object.
For more information about the default root object, see Specify a default root object in the Amazon CloudFront Developer Guide.
" } }, "Origins": { @@ -8211,13 +8211,13 @@ "OriginGroups": { "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { - "smithy.api#documentation": "A complex type that contains information about origin groups for this\n\t\t\tdistribution.
" + "smithy.api#documentation": "A complex type that contains information about origin groups for this distribution.
" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { - "smithy.api#documentation": "A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if files don't match any of the values of\n\t\t\t\tPathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.
A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
A complex type that controls the following:
\nWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom\n\t\t\t\t\terror messages before returning the response to the viewer.
\nHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.
\nFor more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that controls the following:
Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.
" } }, "Comment": { "target": "com.amazonaws.cloudfront#CommentType", "traits": { - "smithy.api#documentation": "A comment to describe the distribution. The comment cannot be longer than\n\t\t\t128 characters.
", + "smithy.api#documentation": "A comment to describe the distribution. The comment cannot be longer than 128 characters.
", "smithy.api#required": {} } }, "Logging": { "target": "com.amazonaws.cloudfront#LoggingConfig", "traits": { - "smithy.api#documentation": "A complex type that controls whether access logs are written for the\n\t\t\tdistribution.
\nFor more information about logging, see Access Logs in\n\t\t\tthe Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
" } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "The price class that corresponds with the maximum price that you want to pay for CloudFront\n\t\t\tservice. If you specify PriceClass_All, CloudFront responds to requests for your\n\t\t\tobjects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All, CloudFront serves your\n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations\n\t\t\tin your price class. Viewers who are in or near regions that are excluded from your\n\t\t\tspecified price class may encounter slower performance.
For more information about price classes, see Choosing the Price\n\t\t\t\tClass for a CloudFront Distribution in the Amazon CloudFront Developer Guide.\n\t\t\tFor information about CloudFront pricing, including how price classes (such as Price Class\n\t\t\t100) map to CloudFront regions, see Amazon CloudFront\n\t\t\t\tPricing.
" + "smithy.api#documentation": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.
If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.
For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.
" } }, "Enabled": { @@ -8262,43 +8262,43 @@ "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.
" + "smithy.api#documentation": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
" } }, "Restrictions": { "target": "com.amazonaws.cloudfront#Restrictions", "traits": { - "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.
" + "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your content.
" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A unique identifier that specifies the WAF web ACL, if any, to associate with this\n\t\t\tdistribution. To specify a web ACL created using the latest version of WAF, use the\n\t\t\tACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\ta1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n\t\t\tthat are forwarded to CloudFront, and lets you control access to your content. Based on\n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or\n\t\t\tthe values of query strings, CloudFront responds to requests either with the requested content\n\t\t\tor with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a\n\t\t\tcustom error page when a request is blocked. For more information about WAF, see the\n\t\t\t\tWAF Developer Guide.
" + "smithy.api#documentation": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.
" } }, "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with\n\t\t\tCloudFront. The default value for new web distributions is http2. Viewers that\n\t\t\tdon't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must\n\t\t\tsupport Server Name Indication (SNI).
\nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to\n\t\t\tswitch networks without losing connection. For more information about connection\n\t\t\tmigration, see Connection Migration at RFC 9000. For more information about supported\n\t\t\tTLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
" + "smithy.api#documentation": "(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.
For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).
For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see Connection Migration at RFC 9000. For more information about supported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.
" } }, "IsIPV6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your\n\t\t\tdistribution, specify true. If you specify false, CloudFront\n\t\t\tresponds to IPv6 DNS requests with the DNS response code NOERROR and with\n\t\t\tno IP addresses. This allows viewers to submit a second request, for an IPv4 address for\n\t\t\tyour distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to\n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict\n\t\t\taccess to your content, and if you're using a custom policy that includes the\n\t\t\t\tIpAddress parameter to restrict the IP addresses that can access your\n\t\t\tcontent, don't enable IPv6. If you want to restrict access to some content by IP address\n\t\t\tand not restrict access to other content (or restrict access but not by IP address), you\n\t\t\tcan create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the\n\t\t\t\tAmazon CloudFront Developer Guide.
If you're using an Route\u00a053 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront\n\t\t\tdistribution, you need to create a second alias resource record set when both of the\n\t\t\tfollowing are true:
\nYou enable IPv6 for the distribution
\nYou're using alternate domain names in the URLs for your objects
\nFor more information, see Routing\n\t\t\t\tTraffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the\n\t\t\t\tRoute\u00a053 Amazon Web Services Integration Developer Guide.
\nIf you created a CNAME resource record set, either with Route\u00a053 Amazon Web Services Integration or with another DNS\n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your\n\t\t\tdistribution regardless of the IP address format of the viewer request.
" + "smithy.api#documentation": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.
In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.
If you're using an Route\u00a053 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:
You enable IPv6 for the distribution
You're using alternate domain names in the URLs for your objects
For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route\u00a053 Amazon Web Services Integration Developer Guide.
If you created a CNAME resource record set, either with Route\u00a053 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.
" } }, "ContinuousDeploymentPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of a continuous deployment policy. For more information, see\n\t\t\t\tCreateContinuousDeploymentPolicy.
The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.
A Boolean that indicates whether this is a staging distribution. When this value is\n\t\t\t\ttrue, this is a staging distribution. When this value is\n\t\t\t\tfalse, this is not a staging distribution.
A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
A distribution Configuration and a list of tags to be associated with the\n\t\t\tdistribution.
" + "smithy.api#documentation": "A distribution Configuration and a list of tags to be associated with the distribution.
" } }, "com.amazonaws.cloudfront#DistributionIdList": { @@ -8359,7 +8359,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing distribution IDs where you left off.
Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.
A flag that indicates whether more distribution IDs remain to be listed. If your\n\t\t\tresults were truncated, you can make a subsequent request using the Marker\n\t\t\trequest field to retrieve more distribution IDs in the list.
A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.
If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour distributions where they left off.
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.
A flag that indicates whether more distributions remain to be listed. If your results\n\t\t\twere truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more distributions in the\n\t\t\tlist.
A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
A complex type that contains one DistributionSummary element for each\n\t\t\tdistribution that was created by the current Amazon Web Services account.
A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
The specified CloudFront distribution is not disabled. You must disable the distribution\n\t\t\tbefore you can delete it.
", + "smithy.api#documentation": "The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -8514,7 +8514,7 @@ "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
The current status of the distribution. When the status is Deployed, the\n\t\t\tdistribution's information is propagated to all CloudFront edge locations.
The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
The domain name that corresponds to the distribution, for example,\n\t\t\t\td111111abcdef8.cloudfront.net.
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.
A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.
", + "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
", "smithy.api#required": {} } }, @@ -8562,13 +8562,13 @@ "OriginGroups": { "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { - "smithy.api#documentation": "A complex type that contains information about origin groups for this\n\t\t\tdistribution.
" + "smithy.api#documentation": "A complex type that contains information about origin groups for this distribution.
" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { - "smithy.api#documentation": "A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if files don't match any of the values of\n\t\t\t\tPathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.
A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
A complex type that contains zero or more CustomErrorResponses\n\t\t\telements.
A complex type that contains zero or more CustomErrorResponses elements.
A complex type that contains information about price class for this streaming\n\t\t\tdistribution.
", + "smithy.api#documentation": "A complex type that contains information about price class for this streaming distribution.
", "smithy.api#required": {} } }, @@ -8610,14 +8610,14 @@ "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.
", + "smithy.api#documentation": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
", "smithy.api#required": {} } }, "Restrictions": { "target": "com.amazonaws.cloudfront#Restrictions", "traits": { - "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.
", + "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your content.
", "smithy.api#required": {} } }, @@ -8631,27 +8631,27 @@ "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "Specify the maximum HTTP version that you want viewers to use to communicate with\n\t\t\tCloudFront. The default value for new web distributions is http2. Viewers that\n\t\t\tdon't support HTTP/2 will automatically use an earlier version.
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your\n\t\t\tdistribution.
", + "smithy.api#documentation": "Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
", "smithy.api#required": {} } }, "AliasICPRecordals": { "target": "com.amazonaws.cloudfront#AliasICPRecordals", "traits": { - "smithy.api#documentation": "Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions.
\nFor more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.
" + "smithy.api#documentation": "Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
" } }, "Staging": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that indicates whether this is a staging distribution. When this value is\n\t\t\t\ttrue, this is a staging distribution. When this value is\n\t\t\t\tfalse, this is not a staging distribution.
A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
The status of your domain name.
\n\n valid-configuration: The domain name is correctly configured and points to the correct routing endpoint of the connection group.
\n invalid-configuration: There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint.
\n unknown-configuration: CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out.
The status of your domain name.
valid-configuration: The domain name is correctly configured and points to the correct routing endpoint of the connection group.
invalid-configuration: There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint.
unknown-configuration: CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out.
Number of field pattern items in a field-level encryption content type-profile\n\t\t\tmapping.
", + "smithy.api#documentation": "Number of field pattern items in a field-level encryption content type-profile mapping.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#EncryptionEntityList", "traits": { - "smithy.api#documentation": "An array of field patterns in a field-level encryption content type-profile mapping.\n\t\t
" + "smithy.api#documentation": "An array of field patterns in a field-level encryption content type-profile mapping.
" } } }, "traits": { - "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes all of the\n\t\t\tencryption entities.
" + "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes all of the encryption entities.
" } }, "com.amazonaws.cloudfront#EncryptionEntity": { @@ -9078,27 +9078,27 @@ "PublicKeyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The public key associated with a set of field-level encryption patterns, to be used\n\t\t\twhen encrypting the fields that match the patterns.
", + "smithy.api#documentation": "The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
", "smithy.api#required": {} } }, "ProviderId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The provider associated with the public key being used for encryption. This value must\n\t\t\talso be provided with the private key for applications to be able to decrypt\n\t\t\tdata.
", + "smithy.api#documentation": "The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
", "smithy.api#required": {} } }, "FieldPatterns": { "target": "com.amazonaws.cloudfront#FieldPatterns", "traits": { - "smithy.api#documentation": "Field patterns in a field-level encryption content type profile specify the fields\n\t\t\tthat you want to be encrypted. You can provide the full field name, or any beginning\n\t\t\tcharacters followed by a wildcard (*). You can't overlap field patterns. For example,\n\t\t\tyou can't have both ABC* and AB*. Note that field patterns are case-sensitive.
", + "smithy.api#documentation": "Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes the encryption key\n\t\t\tand field pattern specifications.
" + "smithy.api#documentation": "Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.
" } }, "com.amazonaws.cloudfront#EncryptionEntityList": { @@ -9116,14 +9116,14 @@ "StreamType": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The type of data stream where you are sending real-time log data. The only valid value\n\t\t\tis Kinesis.
The type of data stream where you are sending real-time log data. The only valid value is Kinesis.
Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data in a real-time log configuration.
" + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
" } } }, @@ -9145,7 +9145,7 @@ } }, "traits": { - "smithy.api#documentation": "The entity already exists. You must provide a unique\n\t\t\tentity.
", + "smithy.api#documentation": "The entity already exists. You must provide a unique entity.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -9224,7 +9224,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The configuration ID for a field-level encryption configuration which includes a set\n\t\t\tof profiles that specify certain selected data fields to be encrypted by specific public\n\t\t\tkeys.
", + "smithy.api#documentation": "The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
", "smithy.api#required": {} } }, @@ -9238,13 +9238,13 @@ "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { - "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level\n\t\t\tencryption.
", + "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level encryption.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A complex data type that includes the profile configurations and other options\n\t\t\tspecified for field-level encryption.
" + "smithy.api#documentation": "A complex data type that includes the profile configurations and other options specified for field-level encryption.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfig": { @@ -9260,24 +9260,24 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An optional comment about the configuration. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "An optional comment about the configuration. The comment cannot be longer than 128 characters.
" } }, "QueryArgProfileConfig": { "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { - "smithy.api#documentation": "A complex data type that specifies when to forward content if a profile isn't found\n\t\t\tand the profile that can be provided as a query argument in a request.
" + "smithy.api#documentation": "A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
" } }, "ContentTypeProfileConfig": { "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", "traits": { - "smithy.api#documentation": "A complex data type that specifies when to forward content if a content type isn't\n\t\t\trecognized and profiles to use as by default in a request if a query argument doesn't\n\t\t\tspecify a profile to use.
" + "smithy.api#documentation": "A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
" } } }, "traits": { - "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level\n\t\t\tencryption.
" + "smithy.api#documentation": "A complex data type that includes the profile configurations specified for field-level encryption.
" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfigAlreadyExists": { @@ -9312,7 +9312,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour configurations where you left off.
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.
The ID for a field-level encryption profile configuration which includes a set of\n\t\t\tprofiles that specify certain selected data fields to be encrypted by specific public\n\t\t\tkeys.
", + "smithy.api#documentation": "The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
", "smithy.api#required": {} } }, @@ -9360,7 +9360,7 @@ "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { - "smithy.api#documentation": "A complex data type that includes the profile name and the encryption entities for the\n\t\t\tfield-level encryption profile.
", + "smithy.api#documentation": "A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
", "smithy.api#required": {} } } @@ -9402,13 +9402,13 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An optional comment for the field-level encryption profile. The comment cannot be\n\t\t\tlonger than 128 characters.
" + "smithy.api#documentation": "An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
" } }, "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { - "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that\n\t\t\tinclude the public key ID, provider, and field patterns for specifying which fields to\n\t\t\tencrypt with this key.
", + "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
", "smithy.api#required": {} } } @@ -9436,13 +9436,13 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour profiles where you left off.
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.
The maximum number of field-level encryption profiles you want in the response body.\n\t\t
", + "smithy.api#documentation": "The maximum number of field-level encryption profiles you want in the response body.
", "smithy.api#required": {} } }, @@ -9490,7 +9490,7 @@ "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "The time when the field-level encryption profile summary was last updated.
", + "smithy.api#documentation": "The time when the field-level encryption profile summary was last updated.
", "smithy.api#required": {} } }, @@ -9504,14 +9504,14 @@ "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { - "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that\n\t\t\tinclude the public key ID, provider, and field patterns for specifying which fields to\n\t\t\tencrypt with this key.
", + "smithy.api#documentation": "A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.
", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An optional comment for the field-level encryption profile summary. The comment cannot\n\t\t\tbe longer than 128 characters.
" + "smithy.api#documentation": "An optional comment for the field-level encryption profile summary. The comment cannot be longer than 128 characters.
" } } }, @@ -9548,7 +9548,7 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An optional comment about the field-level encryption item. The comment cannot be\n\t\t\tlonger than 128 characters.
" + "smithy.api#documentation": "An optional comment about the field-level encryption item. The comment cannot be longer than 128 characters.
" } }, "QueryArgProfileConfig": { @@ -9613,7 +9613,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex data type that includes the field patterns to match for field-level\n\t\t\tencryption.
" + "smithy.api#documentation": "A complex data type that includes the field patterns to match for field-level encryption.
" } }, "com.amazonaws.cloudfront#Format": { @@ -9633,32 +9633,32 @@ "QueryString": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse an origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIndicates whether you want CloudFront to forward query strings to the origin that is\n\t\t\tassociated with this cache behavior and cache based on the query string parameters. CloudFront\n\t\t\tbehavior depends on the value of QueryString and on the values that you\n\t\t\tspecify for QueryStringCacheKeys, if any:
If you specify true for QueryString and you don't specify any values for\n\t\t\t\tQueryStringCacheKeys, CloudFront forwards all query string parameters to the\n\t\t\torigin and caches based on all query string parameters. Depending on how many query\n\t\t\tstring parameters and values you have, this can adversely affect performance because\n\t\t\tCloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values\n\t\t\tfor QueryStringCacheKeys, CloudFront forwards all query string parameters to the\n\t\t\torigin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString, CloudFront doesn't forward any query\n\t\t\tstring parameters to the origin, and doesn't cache based on query string\n\t\t\tparameters.
For more information, see Configuring\n\t\t\t\tCloudFront to Cache Based on Query String Parameters in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Cookies": { "target": "com.amazonaws.cloudfront#CookiePreference", "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nA complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\t\tHow CloudFront Forwards, Caches,\n\t\t\t\tand Logs Cookies in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "Headers": { "target": "com.amazonaws.cloudfront#Headers", "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include headers in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send headers to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nA complex type that specifies the Headers, if any, that you want CloudFront to\n\t\t\tforward to the origin for this cache behavior (whitelisted headers). For the headers\n\t\t\tthat you specify, CloudFront also caches separate versions of a specified object that is based\n\t\t\ton the header values in viewer requests.
For more information, see Caching Content\n\t\t\t\tBased on Request Headers in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
" } }, "QueryStringCacheKeys": { "target": "com.amazonaws.cloudfront#QueryStringCacheKeys", "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse an origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nA complex type that contains information about the query string parameters that you\n\t\t\twant CloudFront to use for caching for this cache behavior.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
" } } }, "traits": { - "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.
\nIf you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.
\nA complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
" } }, "com.amazonaws.cloudfront#FrameOptionsList": { @@ -9696,7 +9696,7 @@ } }, "traits": { - "smithy.api#documentation": "A function with the same name already exists in this Amazon Web Services account. To create a\n\t\t\tfunction, you must provide a unique name. To update an existing function, use\n\t\t\t\tUpdateFunction.
A function with the same name already exists in this Amazon Web Services account. To create a function, you must provide a unique name. To update an existing function, use UpdateFunction.
The event type of the function, either viewer-request or\n\t\t\t\tviewer-response. You cannot use origin-facing event types\n\t\t\t\t(origin-request and origin-response) with a CloudFront\n\t\t\tfunction.
The event type of the function, either viewer-request or viewer-response. You cannot use origin-facing event types (origin-request and origin-response) with a CloudFront function.
A CloudFront function that is associated with a cache behavior in a CloudFront\n\t\t\tdistribution.
" + "smithy.api#documentation": "A CloudFront function that is associated with a cache behavior in a CloudFront distribution.
" } }, "com.amazonaws.cloudfront#FunctionAssociationList": { @@ -9745,12 +9745,12 @@ "Items": { "target": "com.amazonaws.cloudfront#FunctionAssociationList", "traits": { - "smithy.api#documentation": "The CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tYour functions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.
The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the LIVE stage to associate them with a cache behavior.
A list of CloudFront functions that are associated with a cache behavior in a CloudFront\n\t\t\tdistribution. Your functions must be published to the LIVE stage to\n\t\t\tassociate them with a cache behavior.
A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the LIVE stage to associate them with a cache behavior.
Cannot delete the function because it's attached to one or more cache\n\t\t\tbehaviors.
", + "smithy.api#documentation": "Cannot delete the function because it's attached to one or more cache behaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -9829,7 +9829,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing functions where you left off.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing functions where you left off.
The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the\n\t\t\tfunction.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.
", "smithy.api#required": {} } }, "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { - "smithy.api#documentation": "The stage that the function is in, either DEVELOPMENT or\n\t\t\t\tLIVE.
When a function is in the DEVELOPMENT stage, you can test the function\n\t\t\twith TestFunction, and update it with UpdateFunction.
When a function is in the LIVE stage, you can attach the function to a\n\t\t\tdistribution's cache behavior, using the function's ARN.
The stage that the function is in, either DEVELOPMENT or LIVE.
When a function is in the DEVELOPMENT stage, you can test the function with TestFunction, and update it with UpdateFunction.
When a function is in the LIVE stage, you can attach the function to a distribution's cache behavior, using the function's ARN.
The function is too large. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The function is too large. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -9998,26 +9998,26 @@ "RestrictionType": { "target": "com.amazonaws.cloudfront#GeoRestrictionType", "traits": { - "smithy.api#documentation": "The method that you want to use to restrict distribution of your content by country:
\n\n none: No geo restriction is enabled, meaning access to content is\n\t\t\t\t\tnot restricted by client geo location.
\n blacklist: The Location elements specify the\n\t\t\t\t\tcountries in which you don't want CloudFront to distribute your content.
\n whitelist: The Location elements specify the\n\t\t\t\t\tcountries in which you want CloudFront to distribute your content.
The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
When geo restriction is enabled, this is the number of countries in your\n\t\t\t\twhitelist or blacklist. Otherwise, when it is not enabled,\n\t\t\t\tQuantity is 0, and you can omit Items.
When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.
A complex type that contains a Location element for each country in\n\t\t\twhich you want CloudFront either to distribute your content (whitelist) or not\n\t\t\tdistribute your content (blacklist).
The Location element is a two-letter, uppercase country code for a\n\t\t\tcountry that you want to include in your blacklist or\n\t\t\t\twhitelist. Include one Location element for each\n\t\t\tcountry.
CloudFront and MaxMind both use ISO 3166 country codes. For the\n\t\t\tcurrent list of countries and the corresponding codes, see ISO\n\t\t\t\t3166-1-alpha-2 code on the International Organization for\n\t\t\t\tStandardization website. You can also refer to the country list on the\n\t\t\tCloudFront console, which includes both country names and codes.
A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).
The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.
CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
A complex type that controls the countries in which your content is distributed. CloudFront\n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.\n\t\t
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
The method that you want to use to restrict distribution of your content by\n\t\t\tcountry:
\n\n none: No geographic restriction is enabled, meaning access to content is\n\t\t\t\t\tnot restricted by client geo location.
\n blacklist: The Location elements specify the\n\t\t\t\t\tcountries in which you don't want CloudFront to distribute your content.
\n whitelist: The Location elements specify the\n\t\t\t\t\tcountries in which you want CloudFront to distribute your content.
The method that you want to use to restrict distribution of your content by country:
none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
Gets a cache policy, including the following metadata:
\nThe policy's identifier.
\nThe date and time when the policy was last modified.
\nTo get a cache policy, you must provide the policy's identifier. If the cache policy\n\t\t\tis attached to a distribution's cache behavior, you can get the policy's identifier\n\t\t\tusing ListDistributions or GetDistribution. If the cache\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.
Gets a cache policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
Gets a cache policy configuration.
\nTo get a cache policy configuration, you must provide the policy's identifier. If the\n\t\t\tcache policy is attached to a distribution's cache behavior, you can get the policy's\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tcache policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the cache policy\n\t\t\tis not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.
The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the cache policy\n\t\t\tis not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.
The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
The origin access identity's configuration information. For more information, see\n\t\t\t\tCloudFrontOriginAccessIdentityConfig.
", + "smithy.api#documentation": "The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.
", "smithy.api#input": {} } }, @@ -10339,7 +10339,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The current version of the origin access identity's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
Gets a continuous deployment policy, including metadata (the policy's identifier and\n\t\t\tthe date and time when the policy was last modified).
", + "smithy.api#documentation": "Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/continuous-deployment-policy/{Id}", @@ -10570,7 +10570,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of the continuous deployment policy whose configuration you are\n\t\t\tgetting.
", + "smithy.api#documentation": "The identifier of the continuous deployment policy whose configuration you are getting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10592,7 +10592,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.
", + "smithy.api#documentation": "The version identifier for the current version of the continuous deployment policy.
", "smithy.api#httpHeader": "ETag" } } @@ -10630,7 +10630,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.
", + "smithy.api#documentation": "The version identifier for the current version of the continuous deployment policy.
", "smithy.api#httpHeader": "ETag" } } @@ -10714,7 +10714,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The distribution's ID. If the ID is empty, an empty distribution configuration is\n\t\t\treturned.
", + "smithy.api#documentation": "The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10738,7 +10738,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The distribution's ID. If the ID is empty, an empty distribution configuration is\n\t\t\treturned.
", + "smithy.api#documentation": "The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10778,7 +10778,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the distribution's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the distribution's information. For example: E2QWRUHAPOMQZL.
The ID of the distribution tenant. You can specify the ARN ID, or name of the distribution tenant.
", + "smithy.api#documentation": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10992,7 +10992,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
The current version of the field-level encryption profile configuration result. For\n\t\t\texample: E2QWRUHAPOMQZL.
The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.
The current version of the field level encryption profile. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
Gets the code of a CloudFront function. To get configuration information and metadata about\n\t\t\ta function, use DescribeFunction.
To get a function's code, you must provide the function's name and stage. To get these\n\t\t\tvalues, you can use ListFunctions.
Gets the code of a CloudFront function. To get configuration information and metadata about a function, use DescribeFunction.
To get a function's code, you must provide the function's name and stage. To get these values, you can use ListFunctions.
The identifier for the invalidation request, for example,\n\t\t\tIDFDVBD632BHDS5.
The identifier for the invalidation request, for example, IDFDVBD632BHDS5.
The invalidation's information. For more information, see Invalidation\n\t\t\t\tComplex Type.
", + "smithy.api#documentation": "The invalidation's information. For more information, see Invalidation Complex Type.
", "smithy.api#httpPayload": {} } } @@ -11429,7 +11429,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a key group, including the date and time when the key group was last\n\t\t\tmodified.
\nTo get a key group, you must provide the key group's identifier. If the key group is\n\t\t\treferenced in a distribution's cache behavior, you can get the key group's identifier\n\t\t\tusing ListDistributions or GetDistribution. If the key group\n\t\t\tis not referenced in a cache behavior, you can get the identifier using\n\t\t\t\tListKeyGroups.
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets a key group configuration.
\nTo get a key group configuration, you must provide the key group's identifier. If the\n\t\t\tkey group is referenced in a distribution's cache behavior, you can get the key group's\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tkey group is not referenced in a cache behavior, you can get the identifier using\n\t\t\t\tListKeyGroups.
Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
The identifier of the key group whose configuration you are getting. To get the\n\t\t\tidentifier, use ListKeyGroups.
The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.
The identifier of the key group that you are getting. To get the identifier, use\n\t\t\t\tListKeyGroups.
The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.
The identifier of the multi-tenant distribution.
", + "smithy.api#documentation": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11614,7 +11614,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about whether additional CloudWatch metrics are enabled for the\n\t\t\tspecified CloudFront distribution.
", + "smithy.api#documentation": "Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -11644,7 +11644,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.
", + "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#httpPayload": {} } } @@ -11796,7 +11796,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets an origin request policy, including the following metadata:
\nThe policy's identifier.
\nThe date and time when the policy was last modified.
\nTo get an origin request policy, you must provide the policy's identifier. If the\n\t\t\torigin request policy is attached to a distribution's cache behavior, you can get the\n\t\t\tpolicy's identifier using ListDistributions or\n\t\t\tGetDistribution. If the origin request policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.
Gets an origin request policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
Gets an origin request policy configuration.
\nTo get an origin request policy configuration, you must provide the policy's\n\t\t\tidentifier. If the origin request policy is attached to a distribution's cache behavior,\n\t\t\tyou can get the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the origin request policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the origin\n\t\t\trequest policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListOriginRequestPolicies.
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the origin\n\t\t\trequest policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListOriginRequestPolicies.
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
Gets a real-time log configuration.
\nTo get a real-time log configuration, you can provide the configuration's name or its\n\t\t\tAmazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to get.
", + "smithy.api#documentation": "Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/get-realtime-log-config", @@ -12110,7 +12110,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a response headers policy, including metadata (the policy's identifier and the\n\t\t\tdate and time when the policy was last modified).
\nTo get a response headers policy, you must provide the policy's identifier. If the\n\t\t\tresponse headers policy is attached to a distribution's cache behavior, you can get the\n\t\t\tpolicy's identifier using ListDistributions or\n\t\t\tGetDistribution. If the response headers policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListResponseHeadersPolicies.
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
Gets a response headers policy configuration.
\nTo get a response headers policy configuration, you must provide the policy's\n\t\t\tidentifier. If the response headers policy is attached to a distribution's cache\n\t\t\tbehavior, you can get the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
The identifier for the response headers policy.
\nIf the response headers policy is attached to a distribution's cache behavior, you can\n\t\t\tget the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.
The identifier for the response headers policy.
If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
The identifier for the response headers policy.
\nIf the response headers policy is attached to a distribution's cache behavior, you can\n\t\t\tget the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.
The identifier for the response headers policy.
If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies.
Gets information about a specified RTMP distribution, including the distribution\n\t\t\tconfiguration.
", + "smithy.api#documentation": "Gets information about a specified RTMP distribution, including the distribution configuration.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution/{Id}", @@ -12318,7 +12318,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the configuration. For example: E2QWRUHAPOMQZL.\n\t\t
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The current version of the streaming distribution's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your\n\t\t\torigins.
", + "smithy.api#documentation": "Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on\n\t\t\tHTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads,\n\t\t\tmaking it suitable for applications that require low latency communications.
\nTo enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported HTTP versions and allow HTTP methods, including POST.
For more information, see Using gRPC with CloudFront distributions in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications.
To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported HTTP versions and allow HTTP methods, including POST.
For more information, see Using gRPC with CloudFront distributions in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#HeaderList": { @@ -12588,7 +12588,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified configuration for field-level encryption can't be associated with the\n\t\t\tspecified cache behavior.
", + "smithy.api#documentation": "The specified configuration for field-level encryption can't be associated with the specified cache behavior.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12601,7 +12601,7 @@ } }, "traits": { - "smithy.api#documentation": "An origin cannot contain both an origin access control (OAC) and an origin access\n\t\t\tidentity (OAI).
", + "smithy.api#documentation": "An origin cannot contain both an origin access control (OAC) and an origin access identity (OAI).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12660,7 +12660,7 @@ } }, "traits": { - "smithy.api#documentation": "The value of Quantity and the size of Items don't\n\t\t\tmatch.
The value of Quantity and the size of Items don't match.
An origin access control is associated with an origin whose domain name is not\n\t\t\tsupported.
", + "smithy.api#documentation": "An origin access control is associated with an origin whose domain name is not supported.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12738,7 +12738,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request contains forward cookies option which doesn't match with the expectation\n\t\t\tfor the whitelisted list of cookie names. Either list of cookie names has\n\t\t\tbeen specified when not allowed or list of cookie names is missing when expected.
Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.
You cannot specify SSLv3 as the minimum protocol version if you only want to support\n\t\t\tonly clients that support Server Name Indication (SNI).
", + "smithy.api#documentation": "You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12933,7 +12933,7 @@ } }, "traits": { - "smithy.api#documentation": "The relative path is too big, is not URL-encoded, or does not begin with a slash\n\t\t\t(/).
", + "smithy.api#documentation": "The relative path is too big, is not URL-encoded, or does not begin with a slash (/).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12946,7 +12946,7 @@ } }, "traits": { - "smithy.api#documentation": "This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol\n\t\t\tin your request, or omit the RequiredProtocols element from your\n\t\t\tdistribution configuration.
This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.
A web ACL ID specified is not valid. To specify a web ACL created using the latest\n\t\t\tversion of WAF, use the ACL ARN, for example\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.
A web ACL ID specified is not valid. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.
The identifier for the invalidation request. For example:\n\t\t\tIDFDVBD632BHDS5.
The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
The status of the invalidation request. When the invalidation batch is finished, the\n\t\t\tstatus is Completed.
The status of the invalidation request. When the invalidation batch is finished, the status is Completed.
A complex type that contains information about the objects that you want to\n\t\t\tinvalidate. For more information, see Specifying the Objects to Invalidate in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A value that you specify to uniquely identify an invalidation request. CloudFront uses the\n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you\n\t\t\tcreate a new invalidation request, you must specify a new value for\n\t\t\t\tCallerReference and change other values in the request as applicable.\n\t\t\tOne way to ensure that the value of CallerReference is unique is to use a\n\t\t\t\ttimestamp, for example, 20120301090000.
If you make a second invalidation request with the same value for\n\t\t\t\tCallerReference, and if the rest of the request is the same, CloudFront\n\t\t\tdoesn't create a new invalidation request. Instead, CloudFront returns information about the\n\t\t\tinvalidation request that you previously created with the same\n\t\t\t\tCallerReference.
If CallerReference is a value you already sent in a previous invalidation\n\t\t\tbatch request but the content of any Path is different from the original\n\t\t\trequest, CloudFront returns an InvalidationBatchAlreadyExists error.
A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.
If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.
If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
If IsTruncated is true, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your invalidation batches where they left off.
If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.
A flag that indicates whether more invalidation batch requests remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more invalidation batches in the\n\t\t\tlist.
A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.
The number of invalidation batches that were created by the current Amazon Web Services account.\n\t\t
", + "smithy.api#documentation": "The number of invalidation batches that were created by the current Amazon Web Services account.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#InvalidationSummaryList", "traits": { - "smithy.api#documentation": "A complex type that contains one InvalidationSummary element for each\n\t\t\tinvalidation batch created by the current Amazon Web Services account.
A complex type that contains one InvalidationSummary element for each invalidation batch created by the current Amazon Web Services account.
The InvalidationList complex type describes the list of invalidation\n\t\t\tobjects. For more information about invalidation, see Invalidating Objects\n\t\t\t\t(Web Distributions Only) in the Amazon CloudFront Developer Guide.
The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.
A list of identifiers for the public keys that CloudFront can use to verify the signatures\n\t\t\tof signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KGKeyPairIdsList": { @@ -13235,7 +13235,7 @@ } }, "traits": { - "smithy.api#documentation": "A key group.
\nA key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" + "smithy.api#documentation": "A key group.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KeyGroupAlreadyExists": { @@ -13246,7 +13246,7 @@ } }, "traits": { - "smithy.api#documentation": "A key group with this name already exists. You must provide a unique name. To modify\n\t\t\tan existing key group, use UpdateKeyGroup.
A key group with this name already exists. You must provide a unique name. To modify an existing key group, use UpdateKeyGroup.
A comment to describe the key group. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "A comment to describe the key group. The comment cannot be longer than 128 characters.
" } } }, "traits": { - "smithy.api#documentation": "A key group configuration.
\nA key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" + "smithy.api#documentation": "A key group configuration.
A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#KeyGroupList": { @@ -13285,7 +13285,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing key groups.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.
The key value store. Use this to separate data from function code, allowing you to update\n\t\t\tdata without having to publish a new version of a function. The key value store holds\n\t\t\tkeys and their corresponding values.
" + "smithy.api#documentation": "The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.
" } }, "com.amazonaws.cloudfront#KeyValueStoreARN": { @@ -13539,20 +13539,20 @@ "RoleARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to\n\t\t\tsend real-time log data to your Kinesis data stream.
\nFor more information the IAM role, see Real-time log configuration IAM role in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.
For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending\n\t\t\treal-time log data.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
" + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" } }, "com.amazonaws.cloudfront#LambdaFunctionARN": { @@ -13564,21 +13564,21 @@ "LambdaFunctionARN": { "target": "com.amazonaws.cloudfront#LambdaFunctionARN", "traits": { - "smithy.api#documentation": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version;\n\t\t\tyou can't specify an alias or $LATEST.
", + "smithy.api#documentation": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.
", "smithy.api#required": {} } }, "EventType": { "target": "com.amazonaws.cloudfront#EventType", "traits": { - "smithy.api#documentation": "Specifies the event type that triggers a Lambda@Edge function invocation. You can\n\t\t\tspecify the following values:
\n\n viewer-request: The function executes when CloudFront receives a\n\t\t\t\t\trequest from a viewer and before it checks to see whether the requested object\n\t\t\t\t\tis in the edge cache.
\n origin-request: The function executes only when CloudFront sends a\n\t\t\t\t\trequest to your origin. When the requested object is in the edge cache, the\n\t\t\t\t\tfunction doesn't execute.
\n origin-response: The function executes after CloudFront receives a\n\t\t\t\t\tresponse from the origin and before it caches the object in the response. When\n\t\t\t\t\tthe requested object is in the edge cache, the function doesn't execute.
\n viewer-response: The function executes before CloudFront returns the\n\t\t\t\t\trequested object to the viewer. The function executes regardless of whether the\n\t\t\t\t\tobject was already in the edge cache.
If the origin returns an HTTP status code other than HTTP 200 (OK), the\n\t\t\t\t\tfunction doesn't execute.
\nSpecifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:
viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.
origin-request: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.
origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.
viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.
If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
A flag that allows a Lambda@Edge function to have read access to the body content. For\n\t\t\tmore information, see Accessing the Request Body by Choosing the Include Body Option in the\n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
" } } }, @@ -13608,12 +13608,12 @@ "Items": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociationList", "traits": { - "smithy.api#documentation": "\n Optional: A complex type that contains\n\t\t\t\tLambdaFunctionAssociation items for this cache behavior. If\n\t\t\t\tQuantity is 0, you can omit Items.
Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.
A complex type that specifies a list of Lambda@Edge functions associations for a cache\n\t\t\tbehavior.
\nIf you want to invoke one or more Lambda@Edge functions triggered by requests that\n\t\t\tmatch the PathPattern of the cache behavior, specify the applicable values\n\t\t\tfor Quantity and Items. Note that there can be up to 4\n\t\t\t\tLambdaFunctionAssociation items in this list (one for each possible\n\t\t\tvalue of EventType) and each EventType can be associated with\n\t\t\tonly one function.
If you don't want to invoke any Lambda@Edge functions for the requests that match\n\t\t\t\tPathPattern, specify 0 for Quantity and omit\n\t\t\t\tItems.
A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior.
If you want to invoke one or more Lambda@Edge functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with only one function.
If you don't want to invoke any Lambda@Edge functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of Anycast static IP lists that you want returned in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of Anycast static IP lists that you want returned in the response.
", "smithy.api#httpQuery": "MaxItems" } } @@ -13705,7 +13705,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of cache policies.
\nYou can optionally apply a filter to return only the managed policies created by\n\t\t\tAmazon Web Services, or only the custom policies created in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
A filter to return only the specified kinds of cache policies. Valid values\n\t\t\tare:
\n\n managed \u2013 Returns only the managed policies created by\n\t\t\t\t\tAmazon Web Services.
\n custom \u2013 Returns only the custom policies created in your\n\t\t\t\t\tAmazon Web Services account.
A filter to return only the specified kinds of cache policies. Valid values are:
managed \u2013 Returns only the managed policies created by Amazon Web Services.
custom \u2013 Returns only the custom policies created in your Amazon Web Services account.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).
Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or\n\t\t\toverlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services\n\t\t\taccounts for each conflicting alias. In the returned list, the distribution and account\n\t\t\tIDs are partially hidden, which allows you to identify the distributions and accounts\n\t\t\tthat you own, but helps to protect the information of ones that you don't own.
\nUse this operation to find aliases that are in use in CloudFront that conflict or overlap\n\t\t\twith the provided alias. For example, if you provide www.example.com as\n\t\t\tinput, the returned list can include www.example.com and the overlapping\n\t\t\twildcard alternate domain name (*.example.com), if they exist. If you\n\t\t\tprovide *.example.com as input, the returned list can include\n\t\t\t\t*.example.com and any alternate domain names covered by that wildcard\n\t\t\t(for example, www.example.com, test.example.com,\n\t\t\t\tdev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a\n\t\t\tdistribution in your account that has an attached SSL/TLS certificate that includes the\n\t\t\tprovided alias. For more information, including how to set up the distribution and\n\t\t\tcertificate, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
The ID of a distribution in your account that has an attached SSL/TLS certificate that\n\t\t\tincludes the provided alias.
", + "smithy.api#documentation": "The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
", "smithy.api#httpQuery": "DistributionId", "smithy.api#required": {} } @@ -13871,7 +13871,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in the list of\n\t\t\tconflicting aliases. The response includes conflicting aliases in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets a list of the continuous deployment policies in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcontinuous deployment policies. The response includes policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of continuous deployment policies that you want returned in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of continuous deployment policies that you want returned in the response.
", "smithy.api#httpQuery": "MaxItems" } } @@ -14101,7 +14101,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists distribution tenants by the customization that you specify.
\nYou must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.
Lists distribution tenants by the customization that you specify.
You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of distributions that you want returned in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of distributions that you want returned in the response.
", "smithy.api#httpQuery": "MaxItems" } }, @@ -14333,7 +14333,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified cache policy.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets a list of distribution IDs for distributions that have a cache behavior that\n\t\t\treferences the specified key group.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified origin request policy.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The ID of the origin request policy whose associated distribution IDs you want to\n\t\t\tlist.
", + "smithy.api#documentation": "The ID of the origin request policy whose associated distribution IDs you want to list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14617,7 +14617,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of distributions that have a cache behavior that's associated with the\n\t\t\tspecified real-time log configuration.
\nYou can specify the real-time log configuration by its name or its Amazon Resource\n\t\t\tName (ARN). You must provide at least one. If you provide both, CloudFront uses the name to\n\t\t\tidentify the real-time log configuration to list distributions for.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The response includes distributions in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The name of the real-time log configuration whose associated distributions you want to\n\t\t\tlist.
" + "smithy.api#documentation": "The name of the real-time log configuration whose associated distributions you want to list.
" } }, "RealtimeLogConfigArn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration whose associated\n\t\t\tdistributions you want to list.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.
" } } }, @@ -14691,7 +14691,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified response headers policy.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The ID of the response headers policy whose associated distribution IDs you want to\n\t\t\tlist.
", + "smithy.api#documentation": "The ID of the response headers policy whose associated distribution IDs you want to list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14867,28 +14867,28 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use Marker and MaxItems to control pagination of results. If\n\t\t\tyou have more than MaxItems distributions that satisfy the request, the\n\t\t\tresponse includes a NextMarker element. To get the next page of results,\n\t\t\tsubmit another request. For the value of Marker, specify the value of\n\t\t\t\tNextMarker from the last response. (For the first request, omit\n\t\t\t\tMarker.)
Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
The maximum number of distributions that you want CloudFront to return in the response body.\n\t\t\tThe maximum and default values are both 100.
", + "smithy.api#documentation": "The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
", "smithy.api#httpQuery": "MaxItems" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.
\nFor WAFV2, this is the ARN of the web ACL, such as\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The ID of the WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
For WAFV2, this is the ARN of the web ACL, such as arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The request to list distributions that are associated with a specified WAF web\n\t\t\tACL.
", + "smithy.api#documentation": "The request to list distributions that are associated with a specified WAF web ACL.
", "smithy.api#input": {} } }, @@ -14904,7 +14904,7 @@ } }, "traits": { - "smithy.api#documentation": "The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.
", + "smithy.api#documentation": "The response to a request to list the distributions that are associated with a specified WAF web ACL.
", "smithy.api#output": {} } }, @@ -14914,7 +14914,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The results include distributions in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last distribution on that page).
Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).
Lists existing domain associations that conflict with the domain that you specify.
\nYou can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.
", + "smithy.api#documentation": "Lists existing domain associations that conflict with the domain that you specify.
You can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/domain-conflicts", @@ -14994,7 +14994,7 @@ "DomainControlValidationResource": { "target": "com.amazonaws.cloudfront#DistributionResourceId", "traits": { - "smithy.api#documentation": "The distribution resource identifier. This can be the distribution or distribution tenant that has a\n\t\t\tvalid certificate, which covers the domain that you specify.
", + "smithy.api#documentation": "The distribution resource identifier. This can be the distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.
", "smithy.api#required": {} } }, @@ -15049,7 +15049,7 @@ } ], "traits": { - "smithy.api#documentation": "List all field-level encryption configurations that have been created in CloudFront for this\n\t\t\taccount.
", + "smithy.api#documentation": "List all field-level encryption configurations that have been created in CloudFront for this account.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption", @@ -15063,14 +15063,14 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of\n\t\t\tconfigurations. The results include configurations in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last configuration on that page).
Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).
The maximum number of field-level encryption configurations you want in the response\n\t\t\tbody.
", + "smithy.api#documentation": "The maximum number of field-level encryption configurations you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } @@ -15085,7 +15085,7 @@ "FieldLevelEncryptionList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionList", "traits": { - "smithy.api#documentation": "Returns a list of all field-level encryption configurations that have been created in\n\t\t\tCloudFront for this account.
", + "smithy.api#documentation": "Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.
", "smithy.api#httpPayload": {} } } @@ -15108,7 +15108,7 @@ } ], "traits": { - "smithy.api#documentation": "Request a list of field-level encryption profiles that have been created in CloudFront for\n\t\t\tthis account.
", + "smithy.api#documentation": "Request a list of field-level encryption profiles that have been created in CloudFront for this account.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption-profile", @@ -15122,14 +15122,14 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of profiles.\n\t\t\tThe results include profiles in the list that occur after the marker. To get the next\n\t\t\tpage of results, set the Marker to the value of the NextMarker\n\t\t\tfrom the current page's response (which is also the ID of the last profile on that\n\t\t\tpage).
Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).
The maximum number of field-level encryption profiles you want in the response body.\n\t\t
", + "smithy.api#documentation": "The maximum number of field-level encryption profiles you want in the response body.
", "smithy.api#httpQuery": "MaxItems" } } @@ -15144,7 +15144,7 @@ "FieldLevelEncryptionProfileList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileList", "traits": { - "smithy.api#documentation": "Returns a list of the field-level encryption profiles that have been created in CloudFront\n\t\t\tfor this account.
", + "smithy.api#documentation": "Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
", "smithy.api#httpPayload": {} } } @@ -15170,7 +15170,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of all CloudFront functions in your Amazon Web Services account.
\nYou can optionally apply a filter to return only the functions that are in the\n\t\t\tspecified stage, either DEVELOPMENT or LIVE.
You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tfunctions. The response includes functions in the list that occur after the marker. To\n\t\t\tget the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
An optional filter to return only the functions that are in the specified stage,\n\t\t\teither DEVELOPMENT or LIVE.
An optional filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.
Use this parameter when paginating results to indicate where to begin in your list of\n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most\n\t\t\trecent to oldest, the most recent results are on the first page, the second page will\n\t\t\tcontain earlier results, and so on. To get the next page of results, set\n\t\t\t\tMarker to the value of the NextMarker from the current\n\t\t\tpage's response. This value is the same as the ID of the last invalidation batch on that\n\t\t\tpage.
Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
Use this parameter when paginating results to indicate where to begin in your list of\n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most\n\t\t\trecent to oldest, the most recent results are on the first page, the second page will\n\t\t\tcontain earlier results, and so on. To get the next page of results, set\n\t\t\t\tMarker to the value of the NextMarker from the current\n\t\t\tpage's response. This value is the same as the ID of the last invalidation batch on that\n\t\t\tpage.
Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
Gets a list of key groups.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of key\n\t\t\tgroups. The response includes key groups in the list that occur after the marker. To get\n\t\t\tthe next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send another\n\t\t\trequest that specifies the NextMarker value from the current response as\n\t\t\tthe Marker value in the next request.
If you're not using origin access controls for your Amazon Web Services account, the\n\t\t\t\t\tListOriginAccessControls operation doesn't return the\n\t\t\t\t\tItems element in the response.
Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the NextMarker value from the current response as the Marker value in the next request.
If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls operation doesn't return the Items element in the response.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin access controls. The response includes the items in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets a list of origin request policies.
\nYou can optionally apply a filter to return only the managed policies created by\n\t\t\tAmazon Web Services, or only the custom policies created in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:
\n\n managed \u2013 Returns only the managed policies created by\n\t\t\t\t\tAmazon Web Services.
\n custom \u2013 Returns only the custom policies created in your\n\t\t\t\t\tAmazon Web Services account.
A filter to return only the specified kinds of origin request policies. Valid values are:
managed \u2013 Returns only the managed policies created by Amazon Web Services.
custom \u2013 Returns only the custom policies created in your Amazon Web Services account.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field's value to the\n\t\t\tvalue of NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Use this when paginating results to indicate where to begin in your list of public\n\t\t\tkeys. The results include public keys in the list that occur after the marker. To get\n\t\t\tthe next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last public key on that page).
Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).
Returns a list of all public keys that have been added to CloudFront for this\n\t\t\taccount.
", + "smithy.api#documentation": "Returns a list of all public keys that have been added to CloudFront for this account.
", "smithy.api#httpPayload": {} } } @@ -15760,7 +15760,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of real-time log configurations.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
The maximum number of real-time log configurations that you want in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of real-time log configurations that you want in the response.
", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in your list of\n\t\t\treal-time log configurations. The response includes real-time log configurations in the\n\t\t\tlist that occur after the marker. To get the next page of the list, set this field's\n\t\t\tvalue to the value of NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
Gets a list of response headers policies.
\nYou can optionally apply a filter to get only the managed policies created by Amazon Web Services,\n\t\t\tor only the custom policies created in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
A filter to get only the specified kind of response headers policies. Valid values\n\t\t\tare:
\n\n managed \u2013 Gets only the managed policies created by Amazon Web Services.
\n custom \u2013 Gets only the custom policies created in your\n\t\t\t\t\tAmazon Web Services account.
A filter to get only the specified kind of response headers policies. Valid values are:
managed \u2013 Gets only the managed policies created by Amazon Web Services.
custom \u2013 Gets only the custom policies created in your Amazon Web Services account.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tresponse headers policies. The response includes response headers policies in the list\n\t\t\tthat occur after the marker. To get the next page of the list, set this field's value to\n\t\t\tthe value of NextMarker from the current page's response.
Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of response headers policies that you want to get in the\n\t\t\tresponse.
", + "smithy.api#documentation": "The maximum number of response headers policies that you want to get in the response.
", "smithy.api#httpQuery": "MaxItems" } } @@ -16119,7 +16119,7 @@ "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to\n\t\t\tenable logging when you create a distribution or if you want to disable logging for an\n\t\t\texisting distribution, specify false for Enabled, and specify\n\t\t\tempty Bucket and Prefix elements. If you specify\n\t\t\t\tfalse for Enabled but you specify values for\n\t\t\t\tBucket and prefix, the values are automatically\n\t\t\tdeleted.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and prefix, the values are automatically deleted.
Specifies whether you want CloudFront to include cookies in access logs, specify\n\t\t\t\ttrue for IncludeCookies. If you choose to include cookies\n\t\t\tin logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for\n\t\t\tthis distribution. If you don't want to include cookies when you create a distribution\n\t\t\tor if you want to disable include cookies for an existing distribution, specify\n\t\t\t\tfalse for IncludeCookies.
Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.
The Amazon S3 bucket to store the access logs in, for example,\n\t\t\t\tamzn-s3-demo-bucket.s3.amazonaws.com.
The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com.
An optional string that you want CloudFront to prefix to the access log\n\t\t\t\tfilenames for this distribution, for example, myprefix/.\n\t\t\tIf you want to enable logging, but you don't want to specify a prefix, you still must\n\t\t\tinclude an empty Prefix element in the Logging element.
An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that specifies whether access logs are written for the distribution.
\nIf you already enabled standard logging (legacy) and you want to enable standard logging\n\t\t\t\t(v2) to send your access logs to Amazon S3, we recommend that you specify a\n\t\t\t\t\tdifferent Amazon S3 bucket or use a separate\n\t\t\t\t\tpath in the same bucket (for example, use a log prefix or\n\t\t\t\tpartitioning). This helps you keep track of which log files are associated with\n\t\t\t\twhich logging subscription and prevents log files from overwriting each other. For\n\t\t\t\tmore information, see Standard logging (access logs) in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
\nA complex type that specifies whether access logs are written for the distribution.
If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a different Amazon S3 bucket or use a separate path in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see Standard logging (access logs) in the Amazon CloudFront Developer Guide.
The status of the CloudFront managed ACM certificate.
\nYour distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the ETag.
The status of the CloudFront managed ACM certificate.
Your distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the ETag.
Contains details about the validation token host of the specified CloudFront managed ACM certificate.
\nFor cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront.
\nContains details about the validation token host of the specified CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront.
Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
\nFor cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
You can opt out of certificate transparency logging by specifying the disabled\n\t\t\toption. Opt in by specifying enabled. For more information, see Certificate\n\t\t\t\tTransparency Logging in the Certificate Manager User\n\t\t\tGuide.
You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.
This operation requires a body. Ensure that the body is present and the\n\t\t\t\tContent-Type header is set.
This operation requires a body. Ensure that the body is present and the Content-Type header is set.
A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.
" + "smithy.api#documentation": "A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
" } }, "com.amazonaws.cloudfront#MonitoringSubscriptionAlreadyExists": { @@ -16627,39 +16627,39 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A unique identifier for the origin. This value must be unique within the\n\t\t\tdistribution.
\nUse this value to specify the TargetOriginId in a\n\t\t\t\tCacheBehavior or DefaultCacheBehavior.
A unique identifier for the origin. This value must be unique within the distribution.
Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
The domain name for the origin.
\nFor more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The domain name for the origin.
For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "OriginPath": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An optional path that CloudFront appends to the origin domain name when CloudFront requests\n\t\t\tcontent from the origin.
\nFor more information, see Origin Path in the\n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
For more information, see Origin Path in the Amazon CloudFront Developer Guide.
" } }, "CustomHeaders": { "target": "com.amazonaws.cloudfront#CustomHeaders", "traits": { - "smithy.api#documentation": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to\n\t\t\tthe origin.
\nFor more information, see Adding Custom Headers to Origin Requests in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
" } }, "S3OriginConfig": { "target": "com.amazonaws.cloudfront#S3OriginConfig", "traits": { - "smithy.api#documentation": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with\n\t\t\tstatic website hosting. To specify any other type of origin, including an Amazon S3 bucket\n\t\t\tthat is configured with static website hosting, use the CustomOriginConfig\n\t\t\ttype instead.
Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If\n\t\t\tthe Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3\n\t\t\tbucket is not configured with static website hosting, use the\n\t\t\t\tS3OriginConfig type instead.
Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The number of times that CloudFront attempts to connect to the origin. The minimum number is\n\t\t\t1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
\nFor a custom origin (including an Amazon S3 bucket that's configured with static website\n\t\t\thosting), this value also specifies the number of times that CloudFront attempts to get a\n\t\t\tresponse from the origin, in the case of an Origin Response Timeout.
\nFor more information, see Origin Connection Attempts in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
" } }, "ConnectionTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of seconds that CloudFront waits when trying to establish a connection to the\n\t\t\torigin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if\n\t\t\tyou don't specify otherwise) is 10 seconds.
\nFor more information, see Origin Connection Timeout in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
" } }, "OriginShield": { "target": "com.amazonaws.cloudfront#OriginShield", "traits": { - "smithy.api#documentation": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your\n\t\t\torigin.
\nFor more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" } }, "OriginAccessControlId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The unique identifier of an origin access control for this origin.
\nFor more information, see Restricting access to an Amazon S3 origin in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The unique identifier of an origin access control for this origin.
For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "An origin.
\nAn origin is the location where content is stored, and from which CloudFront gets content to\n\t\t\tserve to viewers. To specify an origin:
\nUse S3OriginConfig to specify an Amazon S3 bucket that is not\n\t\t\t\t\tconfigured with static website hosting.
Use VpcOriginConfig to specify a VPC origin.
Use CustomOriginConfig to specify all other kinds of origins,\n\t\t\t\t\tincluding:
An Amazon S3 bucket that is configured with static website hosting
\nAn Elastic Load Balancing load balancer
\nAn Elemental MediaPackage endpoint
\nAn Elemental MediaStore container
\nAny other HTTP server, running on an Amazon EC2 instance or any other kind\n\t\t\t\t\t\t\tof host
\nFor the current maximum number of origins that you can specify per distribution, see\n\t\t\t\tGeneral Quotas on Web Distributions in the\n\t\t\t\tAmazon CloudFront Developer Guide (quotas were formerly referred to as\n\t\t\tlimits).
" + "smithy.api#documentation": "An origin.
An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
Use S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.
Use VpcOriginConfig to specify a VPC origin.
Use CustomOriginConfig to specify all other kinds of origins, including:
An Amazon S3 bucket that is configured with static website hosting
An Elastic Load Balancing load balancer
An Elemental MediaPackage endpoint
An Elemental MediaStore container
Any other HTTP server, running on an Amazon EC2 instance or any other kind of host
For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).
" } }, "com.amazonaws.cloudfront#OriginAccessControl": { @@ -16750,14 +16750,14 @@ "SigningProtocol": { "target": "com.amazonaws.cloudfront#OriginAccessControlSigningProtocols", "traits": { - "smithy.api#documentation": "The signing protocol of the origin access control, which determines how CloudFront signs\n\t\t\t(authenticates) requests. The only valid value is sigv4.
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\t\talways for the most common use case. For more information, see origin access control advanced settings in the\n\t\t\t\tAmazon CloudFront Developer Guide.
This field can have one of the following values:
\n\n always \u2013 CloudFront signs all origin requests, overwriting the\n\t\t\t\t\t\tAuthorization header from the viewer request if one\n\t\t\t\t\texists.
\n never \u2013 CloudFront doesn't sign any origin requests. This value turns\n\t\t\t\t\toff origin access control for all origins in all distributions that use this\n\t\t\t\t\torigin access control.
\n no-override \u2013 If the viewer request doesn't contain the\n\t\t\t\t\t\tAuthorization header, then CloudFront signs the origin request. If\n\t\t\t\t\tthe viewer request contains the Authorization header, then CloudFront\n\t\t\t\t\tdoesn't sign the origin request and instead passes along the\n\t\t\t\t\t\tAuthorization header from the viewer request. WARNING: To pass along the Authorization header\n\t\t\t\t\t\tfrom the viewer request, you must add the\n\t\t\t\t\t\t\tAuthorization header to a cache policy for all cache behaviors that\n\t\t\t\t\t\tuse origins associated with this origin access control.\n
Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.
This field can have one of the following values:
always \u2013 CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.
never \u2013 CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.
no-override \u2013 If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.
Cannot delete the origin access control because it's in use by one or more\n\t\t\tdistributions.
", + "smithy.api#documentation": "Cannot delete the origin access control because it's in use by one or more distributions.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -16799,7 +16799,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value to use in the Marker field of another\n\t\t\trequest to continue listing origin access controls.
If there are more items in the list than are in this response, this element is present. It contains the value to use in the Marker field of another request to continue listing origin access controls.
If there are more items in the list than are in this response, this value is\n\t\t\t\ttrue.
If there are more items in the list than are in this response, this value is true.
The signing protocol of the origin access control. The signing protocol determines how\n\t\t\tCloudFront signs (authenticates) requests. The only valid value is sigv4.
The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.
A value that specifies which requests CloudFront signs (adds authentication information to).\n\t\t\tThis field can have one of the following values:
\n\n never \u2013 CloudFront doesn't sign any origin requests.
\n always \u2013 CloudFront signs all origin requests, overwriting the\n\t\t\t\t\t\tAuthorization header from the viewer request if\n\t\t\t\t\tnecessary.
\n no-override \u2013 If the viewer request doesn't contain the\n\t\t\t\t\t\tAuthorization header, CloudFront signs the origin request. If the\n\t\t\t\t\tviewer request contains the Authorization header, CloudFront doesn't sign\n\t\t\t\t\tthe origin request, but instead passes along the Authorization\n\t\t\t\t\theader that it received in the viewer request.
A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:
never \u2013 CloudFront doesn't sign any origin requests.
always \u2013 CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if necessary.
no-override \u2013 If the viewer request doesn't contain the Authorization header, CloudFront signs the origin request. If the viewer request contains the Authorization header, CloudFront doesn't sign the origin request, but instead passes along the Authorization header that it received in the viewer request.
The name of a header that you want CloudFront to send to your origin. For more information,\n\t\t\tsee Adding\n\t\t\t\tCustom Headers to Origin Requests in the \n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "HeaderValue": { "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { - "smithy.api#documentation": "The value for the header that you specified in the HeaderName\n\t\t\tfield.
The value for the header that you specified in the HeaderName field.
A complex type that contains HeaderName and HeaderValue\n\t\t\telements, if any, for this distribution.
A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.
A complex type that contains information about the failover criteria for an origin\n\t\t\tgroup.
", + "smithy.api#documentation": "A complex type that contains information about the failover criteria for an origin group.
", "smithy.api#required": {} } }, @@ -17014,12 +17014,12 @@ "SelectionCriteria": { "target": "com.amazonaws.cloudfront#OriginGroupSelectionCriteria", "traits": { - "smithy.api#documentation": "The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront\n\t\t\t\tDeveloper Guide.
" + "smithy.api#documentation": "The selection criteria for the origin group. For more information, see Create an origin group in the Amazon CloudFront Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "An origin group includes two origins (a primary origin and a secondary origin to failover\n\t\t\tto) and a failover criteria that you specify. You create an origin group to support\n\t\t\torigin failover in CloudFront. When you create or update a distribution, you can specify the\n\t\t\torigin group instead of a single origin, and CloudFront will failover from the primary origin\n\t\t\tto the secondary origin under the failover conditions that you've chosen.
\nOptionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.
" + "smithy.api#documentation": "An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.
Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.
" } }, "com.amazonaws.cloudfront#OriginGroupFailoverCriteria": { @@ -17034,7 +17034,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex data type that includes information about the failover criteria for an\n\t\t\torigin group, including the status codes for which CloudFront will failover from the\n\t\t\tprimary origin to the second origin.
" + "smithy.api#documentation": "A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.
" } }, "com.amazonaws.cloudfront#OriginGroupList": { @@ -17203,7 +17203,7 @@ } }, "traits": { - "smithy.api#documentation": "An origin request policy.
\nWhen it's attached to a cache behavior, the origin request policy determines the\n\t\t\tvalues that CloudFront includes in requests that it sends to the origin. Each request that\n\t\t\tCloudFront sends to the origin includes the following:
\nThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\nThe headers that CloudFront automatically includes in every origin request,\n\t\t\t\t\tincluding Host, User-Agent, and\n\t\t\t\t\t\tX-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the\n\t\t\t\t\tcache policy or the origin request policy. These can include items from the\n\t\t\t\t\tviewer request and, in the case of headers, additional ones that are added by\n\t\t\t\t\tCloudFront.
\nCloudFront sends a request when it can't find an object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.
An origin request policy.
When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
An origin request policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing origin request policy, use\n\t\t\t\tUpdateOriginRequestPolicy.
An origin request policy with this name already exists. You must provide a unique name. To modify an existing origin request policy, use UpdateOriginRequestPolicy.
A comment to describe the origin request policy. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
" } }, "Name": { @@ -17238,7 +17238,7 @@ "HeadersConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeadersConfig", "traits": { - "smithy.api#documentation": "The HTTP headers to include in origin requests. These can include headers from viewer\n\t\t\trequests and additional headers added by CloudFront.
", + "smithy.api#documentation": "The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
", "smithy.api#required": {} } }, @@ -17258,7 +17258,7 @@ } }, "traits": { - "smithy.api#documentation": "An origin request policy configuration.
\nThis configuration determines the values that CloudFront includes in requests that it sends\n\t\t\tto the origin. Each request that CloudFront sends to the origin includes the following:
\nThe request body and the URL path (without the domain name) from the viewer\n\t\t\t\t\trequest.
\nThe headers that CloudFront automatically includes in every origin request,\n\t\t\t\t\tincluding Host, User-Agent, and\n\t\t\t\t\t\tX-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the\n\t\t\t\t\tcache policy or the origin request policy. These can include items from the\n\t\t\t\t\tviewer request and, in the case of headers, additional ones that are added by\n\t\t\t\t\tCloudFront.
\nCloudFront sends a request when it can't find an object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.
An origin request policy configuration.
This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
Determines whether cookies in viewer requests are included in requests that CloudFront sends\n\t\t\tto the origin. Valid values are:
\n\n none \u2013 No cookies in viewer requests are included in requests that CloudFront sends\n\t\t\t\t\tto the origin. Even when this field is set to none, any cookies\n\t\t\t\t\tthat are listed in a CachePolicy\n are included\n\t\t\t\t\tin origin requests.
\n whitelist \u2013 Only the cookies in viewer requests that are listed in the\n\t\t\t\t\tCookieNames type are included in requests that CloudFront sends to the\n\t\t\t\t\torigin.
\n all \u2013 All cookies in viewer requests are included in requests\n\t\t\t\t\tthat CloudFront sends to the origin.
\n allExcept \u2013 All cookies in viewer requests are included in\n\t\t\t\t\trequests that CloudFront sends to the origin, \n except\n for those listed in the CookieNames\n\t\t\t\t\ttype, which are not included.
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.
whitelist \u2013 Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.
all \u2013 All cookies in viewer requests are included in requests that CloudFront sends to the origin.
allExcept \u2013 All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.
An object that determines whether any cookies in viewer requests (and if so, which\n\t\t\tcookies) are included in requests that CloudFront sends to the origin.
" + "smithy.api#documentation": "An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior": { @@ -17349,7 +17349,7 @@ "HeaderBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior", "traits": { - "smithy.api#documentation": "Determines whether any HTTP headers are included in requests that CloudFront sends to the\n\t\t\torigin. Valid values are:
\n\n none \u2013 No HTTP headers in viewer requests are included in requests that CloudFront\n\t\t\t\t\tsends to the origin. Even when this field is set to none, any\n\t\t\t\t\theaders that are listed in a CachePolicy\n are\n\t\t\t\t\tincluded in origin requests.
\n whitelist \u2013 Only the HTTP headers that are listed in the Headers\n\t\t\t\t\ttype are included in requests that CloudFront sends to the origin.
\n allViewer \u2013 All HTTP headers in viewer requests are included in\n\t\t\t\t\trequests that CloudFront sends to the origin.
\n allViewerAndWhitelistCloudFront \u2013 All HTTP headers in viewer\n\t\t\t\t\trequests and the additional CloudFront headers that are listed in the\n\t\t\t\t\t\tHeaders type are included in requests that CloudFront sends to the\n\t\t\t\t\torigin. The additional headers are added by CloudFront.
\n allExcept \u2013 All HTTP headers in viewer requests are included in\n\t\t\t\t\trequests that CloudFront sends to the origin, \n except\n for those listed in the Headers type,\n\t\t\t\t\twhich are not included.
Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.
whitelist \u2013 Only the HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.
allViewer \u2013 All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
allViewerAndWhitelistCloudFront \u2013 All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.
allExcept \u2013 All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the Headers type, which are not included.
An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in requests that CloudFront sends to the origin.
" + "smithy.api#documentation": "An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicyInUse": { @@ -17369,7 +17369,7 @@ } }, "traits": { - "smithy.api#documentation": "Cannot delete the origin request policy because it is attached to one or more cache\n\t\t\tbehaviors.
", + "smithy.api#documentation": "Cannot delete the origin request policy because it is attached to one or more cache behaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -17380,7 +17380,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing origin request policies where you left\n\t\t\toff.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing origin request policies where you left off.
Determines whether any URL query strings in viewer requests are included in requests\n\t\t\tthat CloudFront sends to the origin. Valid values are:
\n\n none \u2013 No query strings in viewer requests are included in requests that CloudFront\n\t\t\t\t\tsends to the origin. Even when this field is set to none, any query\n\t\t\t\t\tstrings that are listed in a CachePolicy\n are\n\t\t\t\t\tincluded in origin requests.
\n whitelist \u2013 Only the query strings in viewer requests that are listed in the\n\t\t\t\t\tQueryStringNames type are included in requests that CloudFront sends to\n\t\t\t\t\tthe origin.
\n all \u2013 All query strings in viewer requests are included in requests that CloudFront\n\t\t\t\t\tsends to the origin.
\n allExcept \u2013 All query strings in viewer requests are included in\n\t\t\t\t\trequests that CloudFront sends to the origin, \n except\n for those listed in the\n\t\t\t\t\tQueryStringNames type, which are not included.
Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:
none \u2013 No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.
whitelist \u2013 Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.
all \u2013 All query strings in viewer requests are included in requests that CloudFront sends to the origin.
allExcept \u2013 All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.
Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in requests that CloudFront sends to the origin. The\n\t\t\tbehavior depends on whether the QueryStringBehavior field in the\n\t\t\tOriginRequestPolicyQueryStringsConfig type is set to whitelist\n\t\t\t(the listed query strings \n are\n \n\t\t\tincluded) or allExcept (the listed query strings \n are not\n included, but all other query strings\n\t\t\tare).
Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).
An object that determines whether any URL query strings in viewer requests (and if so,\n\t\t\twhich query strings) are included in requests that CloudFront sends to the origin.
" + "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.
" } }, "com.amazonaws.cloudfront#OriginRequestPolicySummary": { @@ -17464,7 +17464,7 @@ "Type": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { - "smithy.api#documentation": "The type of origin request policy, either managed (created by Amazon Web Services) or\n\t\t\t\tcustom (created in this Amazon Web Services account).
The type of origin request policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
A flag that specifies whether Origin Shield is enabled.
\nWhen it's enabled, CloudFront routes all requests through Origin Shield, which can help\n\t\t\tprotect your origin. When it's disabled, CloudFront might send requests directly to your\n\t\t\torigin from multiple edge locations or regional edge caches.
", + "smithy.api#documentation": "A flag that specifies whether Origin Shield is enabled.
When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.
", "smithy.api#required": {} } }, "OriginShieldRegion": { "target": "com.amazonaws.cloudfront#OriginShieldRegion", "traits": { - "smithy.api#documentation": "The Amazon Web Services Region for Origin Shield.
\nSpecify the Amazon Web Services Region that has the lowest latency to your origin. To specify a\n\t\t\tregion, use the region code, not the region name. For example, specify the US East\n\t\t\t(Ohio) region as us-east-2.
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin\n\t\t\tShield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the\n\t\t\tbest Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The Amazon Web Services Region for Origin Shield.
Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2.
When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the Amazon CloudFront Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "CloudFront Origin Shield.
\nUsing Origin Shield can help reduce the load on your origin. For more information, see\n\t\t\t\tUsing Origin Shield in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "CloudFront Origin Shield.
Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#OriginShieldRegion": { @@ -17543,7 +17543,7 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing\n\t\t\tan HTTPS connection with this origin.
", + "smithy.api#documentation": "The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
", "smithy.api#required": {} } }, @@ -17556,7 +17556,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about the SSL/TLS protocols that CloudFront can use\n\t\t\twhen establishing an HTTPS connection with your origin.
" + "smithy.api#documentation": "A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.
" } }, "com.amazonaws.cloudfront#Origins": { @@ -17676,40 +17676,40 @@ "EnableAcceptEncodingGzip": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or\n\t\t\tboth of these fields is true\n and the viewer request includes the Accept-Encoding\n\t\t\theader, then CloudFront does the following:
Normalizes the value of the viewer's Accept-Encoding\n\t\t\t\t\theader
Includes the normalized header in the cache key
\nIncludes the normalized header in the request to the origin, if a request is\n\t\t\t\t\tnecessary
\nFor more information, see Compression support in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the\n\t\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it's not included in the cache key and it's not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Normalizes the value of the viewer's Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or\n\t\t\tboth of these fields is true\n and the viewer request includes the Accept-Encoding\n\t\t\theader, then CloudFront does the following:
Normalizes the value of the viewer's Accept-Encoding\n\t\t\t\t\theader
Includes the normalized header in the cache key
\nIncludes the normalized header in the request to the origin, if a request is\n\t\t\t\t\tnecessary
\nFor more information, see Compression support in the\n\t\t\t\tAmazon CloudFront Developer Guide.
\nIf you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the\n\t\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it's not included in the cache key and it's not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.
A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
Normalizes the value of the viewer's Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.
If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin the cache key and in requests that CloudFront sends to the origin.
", + "smithy.api#documentation": "An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
", "smithy.api#required": {} } }, "CookiesConfig": { "target": "com.amazonaws.cloudfront#CachePolicyCookiesConfig", "traits": { - "smithy.api#documentation": "An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and in requests that CloudFront sends to the origin.
", + "smithy.api#documentation": "An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
", "smithy.api#required": {} } }, "QueryStringsConfig": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig", "traits": { - "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and in requests that CloudFront sends to the\n\t\t\torigin.
", + "smithy.api#documentation": "An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "This object determines the values that CloudFront includes in the cache key. These values\n\t\t\tcan include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to\n\t\t\tfind an object in its cache that it can return to the viewer.
\nThe headers, cookies, and query strings that are included in the cache key are also included\n\t\t\tin requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an\n\t\t\tobject in its cache that matches the request's cache key. If you want to send values to\n\t\t\tthe origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.
This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
The number of invalidation paths specified for the objects that you want to\n\t\t\tinvalidate.
", + "smithy.api#documentation": "The number of invalidation paths specified for the objects that you want to invalidate.
", "smithy.api#required": {} } }, @@ -17739,7 +17739,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about the objects that you want to\n\t\t\tinvalidate. For more information, see Specifying the Objects to Invalidate in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#PreconditionFailed": { @@ -17750,7 +17750,7 @@ } }, "traits": { - "smithy.api#documentation": "The precondition in one or more of the request fields evaluated to\n\t\t\tfalse.
The precondition in one or more of the request fields evaluated to false.
A string included in the request to help make sure that the request can't be\n\t\t\treplayed.
", + "smithy.api#documentation": "A string included in the request to help make sure that the request can't be replayed.
", "smithy.api#required": {} } }, @@ -17853,7 +17853,7 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A comment to describe the public key. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "A comment to describe the public key. The comment cannot be longer than 128 characters.
" } } }, @@ -17889,7 +17889,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour public keys where you left off.
If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.
A comment to describe the public key. The comment cannot be longer than 128\n\t\t\tcharacters.
" + "smithy.api#documentation": "A comment to describe the public key. The comment cannot be longer than 128 characters.
" } } }, @@ -17994,7 +17994,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes a CloudFront function by copying the function code from the\n\t\t\t\tDEVELOPMENT stage to LIVE. This automatically updates all\n\t\t\tcache behaviors that are using this function to use the newly published copy in the\n\t\t\t\tLIVE stage.
When a function is published to the LIVE stage, you can attach the\n\t\t\tfunction to a distribution's cache behavior, using the function's Amazon Resource Name\n\t\t\t(ARN).
To publish a function, you must provide the function's name and version\n\t\t\t\t(ETag value). To get these values, you can use\n\t\t\t\tListFunctions and DescribeFunction.
Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE. This automatically updates all cache behaviors that are using this function to use the newly published copy in the LIVE stage.
When a function is published to the LIVE stage, you can attach the function to a distribution's cache behavior, using the function's Amazon Resource Name (ARN).
To publish a function, you must provide the function's name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction.
The current version (ETag value) of the function that you are publishing,\n\t\t\twhich you can get using DescribeFunction.
The current version (ETag value) of the function that you are publishing, which you can get using DescribeFunction.
Flag to set if you want a request to be forwarded to the origin even if the profile\n\t\t\tspecified by the field-level encryption query argument, fle-profile, is unknown.
", + "smithy.api#documentation": "Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.
", "smithy.api#required": {} } }, "QueryArgProfiles": { "target": "com.amazonaws.cloudfront#QueryArgProfiles", "traits": { - "smithy.api#documentation": "Profiles specified for query argument-profile mapping for field-level\n\t\t\tencryption.
" + "smithy.api#documentation": "Profiles specified for query argument-profile mapping for field-level encryption.
" } } }, @@ -18112,7 +18112,7 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "Number of profiles for query argument-profile mapping for field-level\n\t\t\tencryption.
", + "smithy.api#documentation": "Number of profiles for query argument-profile mapping for field-level encryption.
", "smithy.api#required": {} } }, @@ -18133,19 +18133,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of whitelisted query string parameters for a cache\n\t\t\tbehavior.
The number of whitelisted query string parameters for a cache behavior.
A list that contains the query string parameters that you want CloudFront to use as a basis\n\t\t\tfor caching for a cache behavior. If Quantity is 0, you can omit\n\t\t\t\tItems.
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.
This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.
\nIf you want to include query strings in the cache key, use\n\t\t\t\tQueryStringsConfig in a cache policy. See\n\t\t\tCachePolicy.
If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig in an origin request policy. See\n\t\t\t\tOriginRequestPolicy.
A complex type that contains information about the query string parameters that you\n\t\t\twant CloudFront to use for caching for a cache behavior.
" + "smithy.api#documentation": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use QueryStringsConfig in a cache policy. See CachePolicy.
If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.
A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.
" } }, "com.amazonaws.cloudfront#QueryStringCacheKeysList": { @@ -18207,21 +18207,21 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. The\n\t\t\tsampling rate is an integer between 1 and 100, inclusive.
", + "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.
", "smithy.api#required": {} } }, "EndPoints": { "target": "com.amazonaws.cloudfront#EndPointList", "traits": { - "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data for this real-time log configuration.
", + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
", "smithy.api#required": {} } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "A list of fields that are included in each real-time log record. In an API response,\n\t\t\tthe fields are provided in the same order in which they are sent to the Amazon Kinesis data\n\t\t\tstream.
\nFor more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } @@ -18238,7 +18238,7 @@ } }, "traits": { - "smithy.api#documentation": "A real-time log configuration with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing real-time log configuration, use\n\t\t\t\tUpdateRealtimeLogConfig.
A real-time log configuration with this name already exists. You must provide a unique name. To modify an existing real-time log configuration, use UpdateRealtimeLogConfig.
Cannot delete the real-time log configuration because it is attached to one or more\n\t\t\tcache behaviors.
", + "smithy.api#documentation": "Cannot delete the real-time log configuration because it is attached to one or more cache behaviors.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -18294,21 +18294,21 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A flag that indicates whether there are more real-time log configurations than are\n\t\t\tcontained in this list.
", + "smithy.api#documentation": "A flag that indicates whether there are more real-time log configurations than are contained in this list.
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "This parameter indicates where this list of real-time log configurations begins. This\n\t\t\tlist includes real-time log configurations that occur after the marker.
", + "smithy.api#documentation": "This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.
", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing real-time log configurations where you left off.\n\t\t
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.
A flag that indicates whether additional CloudWatch metrics are enabled for a given\n\t\t\tCloudFront distribution.
", + "smithy.api#documentation": "A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
", "smithy.api#required": {} } } @@ -18459,7 +18459,7 @@ } }, "traits": { - "smithy.api#documentation": "A response headers policy.
\nA response headers policy contains information about a set of HTTP response headers.
\nAfter you create a response headers policy, you can use its ID to attach it to one or more\n\t\t\tcache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the\n\t\t\tresponse headers policy affects the HTTP headers that CloudFront includes in HTTP responses to\n\t\t\trequests that match the cache behavior. CloudFront adds or removes response headers according\n\t\t\tto the configuration of the response headers policy.
\nFor more information, see Adding or removing HTTP headers in CloudFront responses in the\n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A response headers policy.
A response headers policy contains information about a set of HTTP response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowHeaders": { @@ -18475,13 +18475,13 @@ "Items": { "target": "com.amazonaws.cloudfront#AccessControlAllowHeadersList", "traits": { - "smithy.api#documentation": "The list of HTTP header names. You can specify * to allow all\n\t\t\theaders.
The list of HTTP header names. You can specify * to allow all headers.
A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
The list of HTTP methods. Valid values are:
\n\n GET\n
\n DELETE\n
\n HEAD\n
\n OPTIONS\n
\n PATCH\n
\n POST\n
\n PUT\n
\n ALL\n
\n ALL is a special value that includes all of the listed HTTP\n\t\t\tmethods.
The list of HTTP methods. Valid values are:
GET
DELETE
HEAD
OPTIONS
PATCH
POST
PUT
ALL
ALL is a special value that includes all of the listed HTTP methods.
A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
The list of origins (domain names). You can specify * to allow all\n\t\t\torigins.
The list of origins (domain names). You can specify * to allow all origins.
A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\t\tAccess-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
A response headers policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing response headers policy, use\n\t\t\t\tUpdateResponseHeadersPolicy.
A response headers policy with this name already exists. You must provide a unique name. To modify an existing response headers policy, use UpdateResponseHeadersPolicy.
A comment to describe the response headers policy.
\nThe comment cannot be longer than 128 characters.
" + "smithy.api#documentation": "A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
" } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A name to identify the response headers policy.
\nThe name must be unique for response headers policies in this Amazon Web Services account.
", + "smithy.api#documentation": "A name to identify the response headers policy.
The name must be unique for response headers policies in this Amazon Web Services account.
", "smithy.api#required": {} } }, "CorsConfig": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyCorsConfig", "traits": { - "smithy.api#documentation": "A configuration for a set of HTTP response headers that are used for cross-origin\n\t\t\tresource sharing (CORS).
" + "smithy.api#documentation": "A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS).
" } }, "SecurityHeadersConfig": { @@ -18646,7 +18646,7 @@ "ServerTimingHeadersConfig": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig", "traits": { - "smithy.api#documentation": "A configuration for enabling the Server-Timing header in HTTP responses\n\t\t\tsent from CloudFront.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
A response headers policy configuration.
\nA response headers policy configuration contains metadata about the response headers policy,\n\t\t\tand configurations for sets of HTTP response headers.
" + "smithy.api#documentation": "A response headers policy configuration.
A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyContentSecurityPolicy": { @@ -18672,20 +18672,20 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that determines whether CloudFront overrides the\n\t\t\t\tContent-Security-Policy HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.
A Boolean that determines whether CloudFront overrides the Content-Security-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides the\n\t\t\t\tX-Content-Type-Options HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.
A Boolean that determines whether CloudFront overrides the X-Content-Type-Options HTTP response header received from the origin with the one specified in this response headers policy.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.
For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff.
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\t\tAccess-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.
A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.
For more information about the Access-Control-Allow-Origin HTTP response header, see Access-Control-Allow-Origin in the MDN Web Docs.
A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.
A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.
For more information about the Access-Control-Allow-Headers HTTP response header, see Access-Control-Allow-Headers in the MDN Web Docs.
A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.
A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.
For more information about the Access-Control-Allow-Methods HTTP response header, see Access-Control-Allow-Methods in the MDN Web Docs.
A Boolean that CloudFront uses as the value for the\n\t\t\t\tAccess-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP\n\t\t\tresponse header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials HTTP response header.
For more information about the Access-Control-Allow-Credentials HTTP response header, see Access-Control-Allow-Credentials in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.
A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.
For more information about the Access-Control-Expose-Headers HTTP response header, see Access-Control-Expose-Headers in the MDN Web Docs.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP\n\t\t\tresponse header.
For more information about the Access-Control-Max-Age HTTP response\n\t\t\theader, see Access-Control-Max-Age in the MDN Web Docs.
A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP response header.
For more information about the Access-Control-Max-Age HTTP response header, see Access-Control-Max-Age in the MDN Web Docs.
A Boolean that determines whether CloudFront overrides HTTP response headers received from\n\t\t\tthe origin with the ones specified in this response headers policy.
", + "smithy.api#documentation": "A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A configuration for a set of HTTP response headers that are used for cross-origin\n\t\t\tresource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for\n\t\t\tCORS requests that match a cache behavior associated with this response headers\n\t\t\tpolicy.
\nFor more information about CORS, see Cross-Origin Resource\n\t\t\t\tSharing (CORS) in the MDN Web Docs.
" + "smithy.api#documentation": "A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.
For more information about CORS, see Cross-Origin Resource Sharing (CORS) in the MDN Web Docs.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeader": { @@ -18778,13 +18778,13 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that determines whether CloudFront overrides a response header with the same name\n\t\t\treceived from the origin with the header specified here.
", + "smithy.api#documentation": "A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An HTTP response header name and its value. CloudFront includes this header in HTTP\n\t\t\tresponses that it sends for requests that match a cache behavior that's associated with\n\t\t\tthis response headers policy.
" + "smithy.api#documentation": "An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeaderList": { @@ -18814,7 +18814,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of HTTP response header names and their values. CloudFront includes these headers in\n\t\t\tHTTP responses that it sends for requests that match a cache behavior that's associated\n\t\t\twith this response headers policy.
" + "smithy.api#documentation": "A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyFrameOptions": { @@ -18823,20 +18823,20 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP\n\t\t\tresponse header received from the origin with the one specified in this response headers\n\t\t\tpolicy.
A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
The value of the X-Frame-Options HTTP response header. Valid values are\n\t\t\t\tDENY and SAMEORIGIN.
For more information about these values, see X-Frame-Options in the MDN Web Docs.
", + "smithy.api#documentation": "The value of the X-Frame-Options HTTP response header. Valid values are DENY and SAMEORIGIN.
For more information about these values, see X-Frame-Options in the MDN Web Docs.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Determines whether CloudFront includes the X-Frame-Options HTTP response header\n\t\t\tand the header's value.
For more information about the X-Frame-Options HTTP response header, see\n\t\t\t\tX-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header's value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
Cannot delete the response headers policy because it is attached to one or more cache\n\t\t\tbehaviors in a CloudFront distribution.
", + "smithy.api#documentation": "Cannot delete the response headers policy because it is attached to one or more cache behaviors in a CloudFront distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -18858,7 +18858,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing response headers policies where you left\n\t\t\toff.
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing response headers policies where you left off.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP\n\t\t\tresponse header received from the origin with the one specified in this response headers\n\t\t\tpolicy.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
The value of the Referrer-Policy HTTP response header. Valid values\n\t\t\tare:
\n no-referrer\n
\n no-referrer-when-downgrade\n
\n origin\n
\n origin-when-cross-origin\n
\n same-origin\n
\n strict-origin\n
\n strict-origin-when-cross-origin\n
\n unsafe-url\n
For more information about these values, see Referrer-Policy in the MDN Web Docs.
", + "smithy.api#documentation": "The value of the Referrer-Policy HTTP response header. Valid values are:
no-referrer
no-referrer-when-downgrade
origin
origin-when-cross-origin
same-origin
strict-origin
strict-origin-when-cross-origin
unsafe-url
For more information about these values, see Referrer-Policy in the MDN Web Docs.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Determines whether CloudFront includes the Referrer-Policy HTTP response header\n\t\t\tand the header's value.
For more information about the Referrer-Policy HTTP response header, see\n\t\t\t\tReferrer-Policy in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header's value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the\n\t\t\tcache behavior that this response headers policy is attached to.
" + "smithy.api#documentation": "The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyRemoveHeaderList": { @@ -18950,7 +18950,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the\n\t\t\tcache behavior that this response headers policy is attached to.
" + "smithy.api#documentation": "A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicySecurityHeadersConfig": { @@ -18959,42 +18959,42 @@ "XSSProtection": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyXSSProtection", "traits": { - "smithy.api#documentation": "Determines whether CloudFront includes the X-XSS-Protection HTTP response\n\t\t\theader and the header's value.
For more information about the X-XSS-Protection HTTP response header, see\n\t\t\t\tX-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header's value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header\n\t\t\tand the header's value.
For more information about the X-Frame-Options HTTP response header, see\n\t\t\t\tX-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header's value.
For more information about the X-Frame-Options HTTP response header, see X-Frame-Options in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header\n\t\t\tand the header's value.
For more information about the Referrer-Policy HTTP response header, see\n\t\t\t\tReferrer-Policy in the MDN Web Docs.
Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header's value.
For more information about the Referrer-Policy HTTP response header, see Referrer-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.
The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.
For more information about the Content-Security-Policy HTTP response header, see Content-Security-Policy in the MDN Web Docs.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.
For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.
Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff.
For more information about the X-Content-Type-Options HTTP response header, see X-Content-Type-Options in the MDN Web Docs.
Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.
For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Security headers in the Amazon CloudFront Developer Guide and Strict-Transport-Security in the MDN Web Docs.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header's value.
For more information about the Strict-Transport-Security HTTP response header, see Security headers in the Amazon CloudFront Developer Guide and Strict-Transport-Security in the MDN Web Docs.
A configuration for a set of security-related HTTP response headers. CloudFront adds these\n\t\t\theaders to HTTP responses that it sends for requests that match a cache behavior\n\t\t\tassociated with this response headers policy.
" + "smithy.api#documentation": "A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy.
" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig": { @@ -19003,19 +19003,19 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that determines whether CloudFront adds the Server-Timing header to\n\t\t\tHTTP responses that it sends in response to requests that match a cache behavior that's\n\t\t\tassociated with this response headers policy.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A number 0\u2013100 (inclusive) that specifies the percentage of responses that you want\n\t\t\tCloudFront to add the Server-Timing header to. When you set the sampling rate to\n\t\t\t100, CloudFront adds the Server-Timing header to the HTTP response for every\n\t\t\trequest that matches the cache behavior that this response headers policy is attached\n\t\t\tto. When you set it to 50, CloudFront adds the header to 50% of the responses for requests\n\t\t\tthat match the cache behavior. You can set the sampling rate to any number 0\u2013100 with up\n\t\t\tto four decimal places.
A number 0\u2013100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0\u2013100 with up to four decimal places.
A configuration for enabling the Server-Timing header in HTTP responses\n\t\t\tsent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to\n\t\t\trequests that match a cache behavior that's associated with this response headers\n\t\t\tpolicy.
You can use the Server-Timing header to view metrics that can help you\n\t\t\tgain insights about the behavior and performance of CloudFront. For example, you can see which\n\t\t\tcache layer served a cache hit, or the first byte latency from the origin when there was\n\t\t\ta cache miss. You can use the metrics in the Server-Timing header to\n\t\t\ttroubleshoot issues or test the efficiency of your CloudFront configuration. For more\n\t\t\tinformation, see Server-Timing header in the\n\t\t\t\tAmazon CloudFront Developer Guide.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
You can use the Server-Timing header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in the Server-Timing header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.
A Boolean that determines whether CloudFront overrides the\n\t\t\t\tStrict-Transport-Security HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains\n\t\t\tdirective in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in\n\t\t\tthe Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the\n\t\t\t\tStrict-Transport-Security HTTP response header.
A number that CloudFront uses as the value for the max-age directive in the Strict-Transport-Security HTTP response header.
Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.
For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header's value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
The type of response headers policy, either managed (created by Amazon Web Services) or\n\t\t\t\tcustom (created in this Amazon Web Services account).
The type of response headers policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).
A Boolean that determines whether CloudFront overrides the X-XSS-Protection\n\t\t\tHTTP response header received from the origin with the one specified in this response\n\t\t\theaders policy.
A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines the value of the X-XSS-Protection HTTP response\n\t\t\theader. When this setting is true, the value of the\n\t\t\t\tX-XSS-Protection header is 1. When this setting is\n\t\t\t\tfalse, the value of the X-XSS-Protection header is\n\t\t\t\t0.
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
", + "smithy.api#documentation": "A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting is true, the value of the X-XSS-Protection header is 1. When this setting is false, the value of the X-XSS-Protection header is 0.
For more information about these settings, see X-XSS-Protection in the MDN Web Docs.
", "smithy.api#required": {} } }, "ModeBlock": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A Boolean that determines whether CloudFront includes the mode=block directive\n\t\t\tin the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
" + "smithy.api#documentation": "A Boolean that determines whether CloudFront includes the mode=block directive in the X-XSS-Protection header.
For more information about this directive, see X-XSS-Protection in the MDN Web Docs.
" } }, "ReportUri": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A reporting URI, which CloudFront uses as the value of the report directive in\n\t\t\tthe X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is\n\t\t\t\ttrue.
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
" + "smithy.api#documentation": "A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true.
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
" } } }, "traits": { - "smithy.api#documentation": "Determines whether CloudFront includes the X-XSS-Protection HTTP response\n\t\t\theader and the header's value.
For more information about the X-XSS-Protection HTTP response header, see\n\t\t\t\tX-XSS-Protection in the MDN Web Docs.
Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header's value.
For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web Docs.
A complex type that controls the countries in which your content is distributed. CloudFront\n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.
A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.
" + "smithy.api#documentation": "A complex type that identifies ways in which you want to restrict distribution of your content.
" } }, "com.amazonaws.cloudfront#S3Origin": { @@ -19162,13 +19162,13 @@ "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The CloudFront origin access identity to associate with the distribution. Use an origin\n\t\t\taccess identity to configure the distribution so that end users can only access objects\n\t\t\tin an Amazon S3 bucket through CloudFront.
\nIf you want end users to be able to access objects using either the CloudFront URL or the\n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.
\nFor more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in\n\t\t\tthe Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.
If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.
" + "smithy.api#documentation": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
" } }, "com.amazonaws.cloudfront#S3OriginConfig": { @@ -19179,13 +19179,13 @@ "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", - "smithy.api#documentation": "If you're using origin access control (OAC) instead of origin access identity,\n\t\t\t\tspecify an empty OriginAccessIdentity element. For more information,\n\t\t\t\tsee Restricting access to an Amazon Web Services in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access\n\t\t\tidentity to configure the origin so that viewers can only access\n\t\t\tobjects in an Amazon S3 bucket through CloudFront. The format of the value is:
\n\n origin-access-identity/cloudfront/ID-of-origin-access-identity\n
The \n ID-of-origin-access-identity\n is the value that CloudFront\n\t\t\treturned in the ID element when you created the origin access\n\t\t\tidentity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\n\t\t\tURL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.
\nFor more information about the origin access identity, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about the Amazon S3 origin. If the origin is a\n\t\t\tcustom origin or an S3 bucket that is configured as a website endpoint, use the\n\t\t\t\tCustomOriginConfig element instead.
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.
The amount of time after which you want sessions to cease if no requests are\n\t\t\treceived. Allowed values are 300\u20133600 seconds (5\u201360 minutes).
\nThe value must be less than or equal to MaximumTTL.
The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300\u20133600 seconds (5\u201360 minutes).
The value must be less than or equal to MaximumTTL.
The maximum amount of time to consider requests from the viewer as being part of the\n\t\t\tsame session. Allowed values are 300\u20133600 seconds (5\u201360 minutes).
\nThe value must be greater than or equal to IdleTTL.
The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300\u20133600 seconds (5\u201360 minutes).
The value must be greater than or equal to IdleTTL.
Session stickiness provides the ability to define multiple requests from a single\n\t\t\tviewer as a single session. This prevents the potentially inconsistent experience of\n\t\t\tsending some of a given user's requests to your staging distribution, while others are\n\t\t\tsent to your primary distribution. Define the session duration using TTL values.
" + "smithy.api#documentation": "Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
" } }, "com.amazonaws.cloudfront#Signer": { @@ -19248,7 +19248,7 @@ "AwsAccountNumber": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns\n\t\t\tthe key pairs is the same account that owns the CloudFront distribution, the value of this\n\t\t\tfield is self.
An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies.
" + "smithy.api#documentation": "A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#SignerList": { @@ -19386,7 +19386,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex data type for the status codes that you specify that, when returned by a\n\t\t\tprimary origin, trigger CloudFront to failover to a second origin.
" + "smithy.api#documentation": "A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.
" } }, "com.amazonaws.cloudfront#StreamingDistribution": { @@ -19395,21 +19395,21 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier for the RTMP distribution. For example:\n\t\t\tEGTXBD79EXAMPLE.
The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.
The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
The current status of the RTMP distribution. When the status is Deployed,\n\t\t\tthe distribution's information is propagated to all CloudFront edge locations.
The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
The domain name that corresponds to the streaming distribution, for example,\n\t\t\t\ts5c39gqb8ow64r.cloudfront.net.
The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.
A complex type that lists the Amazon Web Services accounts, if any, that you included in the\n\t\t\t\tTrustedSigners complex type for this distribution. These are the\n\t\t\taccounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted\n\t\t\tsigner or self if the signer is the Amazon Web Services account that created the\n\t\t\tdistribution. The Signer element also includes the IDs of any active CloudFront\n\t\t\tkey pairs that are associated with the trusted signer's Amazon Web Services account. If no\n\t\t\t\tKeyPairId element appears for a Signer, that signer can't\n\t\t\tcreate signed URLs.
For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, @@ -19442,7 +19442,7 @@ } }, "traits": { - "smithy.api#documentation": "A streaming distribution tells CloudFront where you want RTMP content to be delivered from,\n\t\t\tand the details about how to track and manage content delivery.
" + "smithy.api#documentation": "A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.
" } }, "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists": { @@ -19453,7 +19453,7 @@ } }, "traits": { - "smithy.api#documentation": "The caller reference you attempted to create the streaming distribution with is\n\t\t\tassociated with another distribution
", + "smithy.api#documentation": "The caller reference you attempted to create the streaming distribution with is associated with another distribution
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -19464,21 +19464,21 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.
\nIf the value of CallerReference is new (regardless of the content of the\n\t\t\t\tStreamingDistributionConfig object), CloudFront creates a new\n\t\t\tdistribution.
If CallerReference is a value that you already sent in a previous request\n\t\t\tto create a distribution, CloudFront returns a DistributionAlreadyExists\n\t\t\terror.
A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.
If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.
A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.
", + "smithy.api#documentation": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
", "smithy.api#required": {} } }, "Aliases": { "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this streaming distribution.
" + "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
" } }, "Comment": { @@ -19491,26 +19491,26 @@ "Logging": { "target": "com.amazonaws.cloudfront#StreamingLoggingConfig", "traits": { - "smithy.api#documentation": "A complex type that controls whether access logs are written for the streaming\n\t\t\tdistribution.
" + "smithy.api#documentation": "A complex type that controls whether access logs are written for the streaming distribution.
" } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "A complex type that specifies any Amazon Web Services accounts that you want to permit to create\n\t\t\tsigned URLs for private content. If you want the distribution to use signed URLs,\n\t\t\tinclude this element; if you want the distribution to use public URLs, remove this\n\t\t\telement. For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "A complex type that contains information about price class for this streaming\n\t\t\tdistribution.
" + "smithy.api#documentation": "A complex type that contains information about price class for this streaming distribution.
" } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "Whether the streaming distribution is enabled to accept user requests for\n\t\t\tcontent.
", + "smithy.api#documentation": "Whether the streaming distribution is enabled to accept user requests for content.
", "smithy.api#required": {} } } @@ -19538,7 +19538,7 @@ } }, "traits": { - "smithy.api#documentation": "A streaming distribution Configuration and a list of tags to be associated with the\n\t\t\tstreaming distribution.
" + "smithy.api#documentation": "A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.
" } }, "com.amazonaws.cloudfront#StreamingDistributionList": { @@ -19554,7 +19554,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour RTMP distributions where they left off.
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.
A flag that indicates whether more streaming distributions remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more distributions in the list.\n\t\t
A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
The number of streaming distributions that were created by the current Amazon Web Services account.\n\t\t
", + "smithy.api#documentation": "The number of streaming distributions that were created by the current Amazon Web Services account.
", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#StreamingDistributionSummaryList", "traits": { - "smithy.api#documentation": "A complex type that contains one StreamingDistributionSummary element for\n\t\t\teach distribution that was created by the current Amazon Web Services account.
A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current Amazon Web Services account.
The specified CloudFront distribution is not disabled. You must disable the distribution\n\t\t\tbefore you can delete it.
", + "smithy.api#documentation": "The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -19615,14 +19615,14 @@ "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) for the streaming distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5,\n\t\t\twhere 123456789012 is your Amazon Web Services account ID.
The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
Indicates the current status of the distribution. When the status is\n\t\t\t\tDeployed, the distribution's information is fully propagated throughout\n\t\t\tthe Amazon CloudFront system.
Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
The domain name corresponding to the distribution, for example,\n\t\t\t\td111111abcdef8.cloudfront.net.
The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.
", + "smithy.api#documentation": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
", "smithy.api#required": {} } }, "Aliases": { "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this streaming distribution.
", + "smithy.api#documentation": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
", "smithy.api#required": {} } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to\n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests\n\t\t\tfor objects in the target origin that match the PathPattern for this cache\n\t\t\tbehavior, specify true for Enabled, and specify the applicable\n\t\t\tvalues for Quantity and Items.If you don't want to require\n\t\t\tsigned URLs in requests for objects that match PathPattern, specify\n\t\t\t\tfalse for Enabled and 0 for\n\t\t\t\tQuantity. Omit Items. To add, change, or remove one or\n\t\t\tmore trusted signers, change Enabled to true (if it's\n\t\t\tcurrently false), change Quantity as applicable, and specify\n\t\t\tall of the trusted signers that you want to include in the updated distribution.
For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } }, @@ -19671,7 +19671,7 @@ "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "A complex type that contains information about price class for this streaming\n\t\t\tdistribution.
", + "smithy.api#documentation": "A complex type that contains information about price class for this streaming distribution.
", "smithy.api#required": {} } }, @@ -19702,27 +19702,27 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't\n\t\t\twant to enable logging when you create a streaming distribution or if you want to\n\t\t\tdisable logging for an existing streaming distribution, specify false for\n\t\t\t\tEnabled, and specify empty Bucket and Prefix\n\t\t\telements. If you specify false for Enabled but you specify\n\t\t\tvalues for Bucket and Prefix, the values are automatically\n\t\t\tdeleted.
Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
The Amazon S3 bucket to store the access logs in, for example,\n\t\t\t\tamzn-s3-demo-bucket.s3.amazonaws.com.
The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com.
An optional string that you want CloudFront to prefix to the access log filenames for this\n\t\t\tstreaming distribution, for example, myprefix/. If you want to enable\n\t\t\tlogging, but you don't want to specify a prefix, you still must include an empty\n\t\t\t\tPrefix element in the Logging element.
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A complex type that controls whether access logs are written for this streaming\n\t\t\tdistribution.
" + "smithy.api#documentation": "A complex type that controls whether access logs are written for this streaming distribution.
" } }, "com.amazonaws.cloudfront#StringSchemaConfig": { @@ -19758,14 +19758,14 @@ "Key": { "target": "com.amazonaws.cloudfront#TagKey", "traits": { - "smithy.api#documentation": "A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
Tests a CloudFront function.
\nTo test a function, you provide an event object that represents\n\t\t\tan HTTP request or response that your CloudFront distribution could receive in production.\n\t\t\tCloudFront runs the function, passing it the event object that you provided, and returns the\n\t\t\tfunction's result (the modified event object) in the response. The response also\n\t\t\tcontains function logs and error messages, if any exist. For more information about\n\t\t\ttesting functions, see Testing functions in the Amazon CloudFront Developer Guide.
\nTo test a function, you provide the function's name and version (ETag\n\t\t\tvalue) along with the event object. To get the function's name and version, you can use\n\t\t\t\tListFunctions and DescribeFunction.
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function's name and version (ETag value) along with the event object. To get the function's name and version, you can use ListFunctions and DescribeFunction.
The current version (ETag value) of the function that you are testing,\n\t\t\twhich you can get using DescribeFunction.
The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.
The stage of the function that you are testing, either DEVELOPMENT or\n\t\t\t\tLIVE.
The stage of the function that you are testing, either DEVELOPMENT or LIVE.
The event object to test the function with. For more information about the structure\n\t\t\tof the event object, see Testing functions in the Amazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } @@ -20001,7 +20001,7 @@ "TestResult": { "target": "com.amazonaws.cloudfront#TestResult", "traits": { - "smithy.api#documentation": "An object that represents the result of running the function with the provided event\n\t\t\tobject.
", + "smithy.api#documentation": "An object that represents the result of running the function with the provided event object.
", "smithy.api#httpPayload": {} } } @@ -20016,13 +20016,13 @@ "FunctionSummary": { "target": "com.amazonaws.cloudfront#FunctionSummary", "traits": { - "smithy.api#documentation": "Contains configuration information and metadata about the CloudFront function that was\n\t\t\ttested.
" + "smithy.api#documentation": "Contains configuration information and metadata about the CloudFront function that was tested.
" } }, "ComputeUtilization": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The amount of time that the function took to run as a percentage of the maximum\n\t\t\tallowed time. For example, a compute utilization of 35 means that the function completed\n\t\t\tin 35% of the maximum allowed time.
" + "smithy.api#documentation": "The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.
" } }, "FunctionExecutionLogs": { @@ -20034,13 +20034,13 @@ "FunctionErrorMessage": { "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { - "smithy.api#documentation": "If the result of testing the function was an error, this field contains the error\n\t\t\tmessage.
" + "smithy.api#documentation": "If the result of testing the function was an error, this field contains the error message.
" } }, "FunctionOutput": { "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { - "smithy.api#documentation": "The event object returned by the function. For more information about the structure of\n\t\t\tthe event object, see Event\n\t\t\t\tobject structure in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.
" } } }, @@ -20056,7 +20056,7 @@ } }, "traits": { - "smithy.api#documentation": "The length of the Content-Security-Policy header value in the response\n\t\t\theaders policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The length of the Content-Security-Policy header value in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20082,7 +20082,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of cache policies for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of cache policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20108,7 +20108,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin access\n\t\t\tidentities allowed.
", + "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin access identities allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20121,7 +20121,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of continuous deployment policies for this\n\t\t\tAmazon Web Services account.
", + "smithy.api#documentation": "You have reached the maximum number of continuous deployment policies for this Amazon Web Services account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20134,7 +20134,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request contains more cookie names in the whitelist than are allowed per cache\n\t\t\tbehavior.
", + "smithy.api#documentation": "Your request contains more cookie names in the whitelist than are allowed per cache behavior.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20147,7 +20147,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of cookies in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of cookies in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20160,7 +20160,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of cookies in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of cookies in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20173,7 +20173,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of custom headers in the response headers policy exceeds the\n\t\t\tmaximum.
\nFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of custom headers in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20199,7 +20199,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of distributions\n\t\t\tallowed.
", + "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of distributions allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20212,7 +20212,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified cache\n\t\t\tpolicy. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified cache policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20225,7 +20225,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified\n\t\t\tconfiguration for field-level encryption.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified configuration for field-level encryption.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20238,7 +20238,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of distributions that reference this key group is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of distributions that reference this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20251,7 +20251,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified origin\n\t\t\taccess control.
\nFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified origin access control.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20264,7 +20264,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified origin\n\t\t\trequest policy. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified origin request policy. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20277,7 +20277,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified response\n\t\t\theaders policy.
\nFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified response headers policy.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20290,7 +20290,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of distributions that are associated with a CloudFront\n\t\t\tfunction. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of distributions that are associated with a CloudFront function. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20303,7 +20303,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause the maximum number of distributions with\n\t\t\tLambda@Edge function associations per owner to be exceeded.
", + "smithy.api#documentation": "Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner to be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20316,7 +20316,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of distributions have been associated with the specified\n\t\t\tLambda@Edge function.
", + "smithy.api#documentation": "The maximum number of distributions have been associated with the specified Lambda@Edge function.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20329,7 +20329,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of configurations for field-level encryption have been\n\t\t\tcreated.
", + "smithy.api#documentation": "The maximum number of configurations for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20342,7 +20342,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of content type profiles for field-level encryption have been\n\t\t\tcreated.
", + "smithy.api#documentation": "The maximum number of content type profiles for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20355,7 +20355,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of encryption entities for field-level encryption have been\n\t\t\tcreated.
", + "smithy.api#documentation": "The maximum number of encryption entities for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20368,7 +20368,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of field patterns for field-level encryption have been\n\t\t\tcreated.
", + "smithy.api#documentation": "The maximum number of field patterns for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20394,7 +20394,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of query arg profiles for field-level encryption have been\n\t\t\tcreated.
", + "smithy.api#documentation": "The maximum number of query arg profiles for field-level encryption have been created.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20407,7 +20407,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of CloudFront function associations for this\n\t\t\tdistribution. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of CloudFront function associations for this distribution. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20420,7 +20420,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20433,7 +20433,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of headers in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of headers in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20459,7 +20459,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of headers in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of headers in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20472,7 +20472,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded the maximum number of allowable InProgress invalidation batch\n\t\t\trequests, or invalidation objects.
", + "smithy.api#documentation": "You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20485,7 +20485,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of key groups for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of key groups for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20498,7 +20498,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of key groups referenced by this distribution is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of key groups referenced by this distribution is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20511,7 +20511,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request contains more Lambda@Edge function associations than are allowed per\n\t\t\tdistribution.
", + "smithy.api#documentation": "Your request contains more Lambda@Edge function associations than are allowed per distribution.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20524,7 +20524,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of origin access controls in your Amazon Web Services account exceeds the maximum\n\t\t\tallowed.
\nFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of origin access controls in your Amazon Web Services account exceeds the maximum allowed.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20550,7 +20550,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin groups\n\t\t\tallowed.
", + "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of origin groups allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20563,7 +20563,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of origin request policies for this Amazon Web Services account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of origin request policies for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20589,7 +20589,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of public keys for field-level encryption have been created. To\n\t\t\tcreate a new public key, delete one of the existing keys.
", + "smithy.api#documentation": "The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20602,7 +20602,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of public keys in this key group is more than the maximum allowed. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of public keys in this key group is more than the maximum allowed. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20628,7 +20628,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of query strings in the cache policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of query strings in the cache policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20641,7 +20641,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of query strings in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of query strings in the origin request policy exceeds the maximum. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20654,7 +20654,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of real-time log configurations for this\n\t\t\tAmazon Web Services account. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of real-time log configurations for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20667,7 +20667,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of headers in RemoveHeadersConfig in the response headers\n\t\t\tpolicy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The number of headers in RemoveHeadersConfig in the response headers policy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20680,7 +20680,7 @@ } }, "traits": { - "smithy.api#documentation": "You have reached the maximum number of response headers policies for this\n\t\t\tAmazon Web Services account.
\nFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "You have reached the maximum number of response headers policies for this Amazon Web Services account.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20706,7 +20706,7 @@ } }, "traits": { - "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of streaming\n\t\t\tdistributions allowed.
", + "smithy.api#documentation": "Processing your request would cause you to exceed the maximum number of streaming distributions allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -20779,7 +20779,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "This field is true if any of the key groups in the list have public keys\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies. If not,\n\t\t\tthis field is false.
This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
A list of key groups whose public keys CloudFront can use to verify the signatures of signed\n\t\t\tURLs and signed cookies.
" + "smithy.api#documentation": "A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#TrustedSignerDoesNotExist": { @@ -20820,7 +20820,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "This field is true if any of the Amazon Web Services accounts in the list are configured as\n\t\t\ttrusted signers. If not, this field is false.
This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of\n\t\t\tsigned URLs and signed cookies.
" + "smithy.api#documentation": "A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
" } }, "com.amazonaws.cloudfront#UnsupportedOperation": { @@ -20956,7 +20956,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a cache policy configuration.
\nWhen you update a cache policy configuration, all the fields are updated with the\n\t\t\tvalues provided in the request. You cannot update some fields independent of others. To\n\t\t\tupdate a cache policy configuration:
\nUse GetCachePolicyConfig to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to\n\t\t\t\t\tupdate.
\nCall UpdateCachePolicy by providing the entire cache policy\n\t\t\t\t\tconfiguration, including the fields that you modified and those that you\n\t\t\t\t\tdidn't.
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.
The unique identifier for the cache policy that you are updating. The identifier is\n\t\t\treturned in a cache behavior's CachePolicyId field in the response to\n\t\t\t\tGetDistributionConfig.
The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior's CachePolicyId field in the response to GetDistributionConfig.
The version of the cache policy that you are updating. The version is returned in the\n\t\t\tcache policy's ETag field in the response to\n\t\t\t\tGetCachePolicyConfig.
The version of the cache policy that you are updating. The version is returned in the cache policy's ETag field in the response to GetCachePolicyConfig.
The value of the ETag header that you received when retrieving the\n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
Enable IPv6 for the connection group. For more information, see Enable IPv6 in the \n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Enable IPv6 for the connection group. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
" } }, "IfMatch": { @@ -21256,7 +21256,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a continuous deployment policy. You can update a continuous deployment policy\n\t\t\tto enable or disable it, to change the percentage of traffic that it sends to the\n\t\t\tstaging distribution, or to change the staging distribution that it sends traffic\n\t\t\tto.
\nWhen you update a continuous deployment policy configuration, all the fields are\n\t\t\tupdated with the values that are provided in the request. You cannot update some fields\n\t\t\tindependent of others. To update a continuous deployment policy configuration:
\nUse GetContinuousDeploymentPolicyConfig to get the current\n\t\t\t\t\tconfiguration.
Locally modify the fields in the continuous deployment policy configuration\n\t\t\t\t\tthat you want to update.
\nUse UpdateContinuousDeploymentPolicy, providing the entire\n\t\t\t\t\tcontinuous deployment policy configuration, including the fields that you\n\t\t\t\t\tmodified and those that you didn't.
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
Use GetContinuousDeploymentPolicyConfig to get the current configuration.
Locally modify the fields in the continuous deployment policy configuration that you want to update.
Use UpdateContinuousDeploymentPolicy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
The current version (ETag value) of the continuous deployment policy that\n\t\t\tyou are updating.
The current version (ETag value) of the continuous deployment policy that you are updating.
The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.
", + "smithy.api#documentation": "The version identifier for the current version of the continuous deployment policy.
", "smithy.api#httpHeader": "ETag" } } @@ -21530,7 +21530,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration for a CloudFront distribution.
\nThe update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.
\n To update a web distribution using the CloudFront\n\t\t\tAPI\n
\nUse GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:
\nYou must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag\n\t\t\t\t\t\t\tfield from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates.
To update a web distribution using the CloudFront API
Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag field from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an UpdateDistribution request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
The value of the ETag header that you received when retrieving the\n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.
The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
Copies the staging distribution's configuration to its corresponding primary\n\t\t\tdistribution. The primary distribution retains its Aliases (also known as\n\t\t\talternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value,\n\t\t\tbut otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested\n\t\t\tconfiguration changes on the staging distribution. After using a continuous deployment\n\t\t\tpolicy to move a portion of your domain name's traffic to the staging distribution and\n\t\t\tverifying that it works as intended, you can use this operation to copy the staging\n\t\t\tdistribution's configuration to the primary distribution. This action will disable the\n\t\t\tcontinuous deployment policy and move your domain's traffic back to the primary distribution.
\nThis API operation requires the following IAM permissions:
\n\n GetDistribution\n
\n\n UpdateDistribution\n
\nCopies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases (also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{Id}/promote-staging-config", @@ -21939,7 +21939,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of the primary distribution to which you are copying a staging distribution's\n\t\t\tconfiguration.
", + "smithy.api#documentation": "The identifier of the primary distribution to which you are copying a staging distribution's configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21954,7 +21954,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current versions (ETag values) of both primary and staging distributions.\n\t\t\tProvide these in the following format:
\n <primary ETag>, <staging ETag>\n
The current versions (ETag values) of both primary and staging distributions. Provide these in the following format:
<primary ETag>, <staging ETag>
The value of the ETag header that you received when retrieving the\n\t\t\tconfiguration identity to update. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when updating the\n\t\t\tconfiguration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the\n\t\t\tprofile identity to update. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.
Updates a CloudFront function.
\nYou can update a function's code or the comment that describes the function. You\n\t\t\tcannot update a function's name.
\nTo update a function, you provide the function's name and version (ETag\n\t\t\tvalue) along with the updated function code. To get the name and version, you can use\n\t\t\t\tListFunctions and DescribeFunction.
Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction.
The current version (ETag value) of the function that you are updating,\n\t\t\twhich you can get using DescribeFunction.
The current version (ETag value) of the function that you are updating, which you can get using DescribeFunction.
The function code. For more information about writing a CloudFront function, see Writing\n\t\t\t\tfunction code for CloudFront Functions in the\n\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#documentation": "The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } } @@ -22466,7 +22466,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a key group.
\nWhen you update a key group, all the fields are updated with the values provided in\n\t\t\tthe request. You cannot update some fields independent of others. To update a key\n\t\t\tgroup:
\nGet the current key group with GetKeyGroup or\n\t\t\t\t\t\tGetKeyGroupConfig.
Locally modify the fields in the key group that you want to update. For\n\t\t\t\t\texample, add or remove public key IDs.
\nCall UpdateKeyGroup with the entire key group object, including\n\t\t\t\t\tthe fields that you modified and those that you didn't.
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with GetKeyGroup or GetKeyGroupConfig.
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn't.
The version of the key group that you are updating. The version is the key group's\n\t\t\t\tETag value.
The version of the key group that you are updating. The version is the key group's ETag value.
The current version (ETag value) of the origin access control that you\n\t\t\tare updating.
The current version (ETag value) of the origin access control that you are updating.
Updates an origin request policy configuration.
\nWhen you update an origin request policy configuration, all the fields are updated\n\t\t\twith the values provided in the request. You cannot update some fields independent of\n\t\t\tothers. To update an origin request policy configuration:
\nUse GetOriginRequestPolicyConfig to get the current\n\t\t\t\t\tconfiguration.
Locally modify the fields in the origin request policy configuration that you\n\t\t\t\t\twant to update.
\nCall UpdateOriginRequestPolicy by providing the entire origin\n\t\t\t\t\trequest policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn't.
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
The unique identifier for the origin request policy that you are updating. The\n\t\t\tidentifier is returned in a cache behavior's OriginRequestPolicyId field in\n\t\t\tthe response to GetDistributionConfig.
The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior's OriginRequestPolicyId field in the response to GetDistributionConfig.
The version of the origin request policy that you are updating. The version is\n\t\t\treturned in the origin request policy's ETag field in the response to\n\t\t\t\tGetOriginRequestPolicyConfig.
The version of the origin request policy that you are updating. The version is returned in the origin request policy's ETag field in the response to GetOriginRequestPolicyConfig.
Update public key information. Note that the only value you can change is the\n\t\t\tcomment.
", + "smithy.api#documentation": "Update public key information. Note that the only value you can change is the comment.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/public-key/{Id}/config", @@ -22904,7 +22904,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of the ETag header that you received when retrieving the public\n\t\t\tkey to update. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.
Updates a real-time log configuration.
\nWhen you update a real-time log configuration, all the parameters are updated with the\n\t\t\tvalues provided in the request. You cannot update some parameters independent of others.\n\t\t\tTo update a real-time log configuration:
\nCall GetRealtimeLogConfig to get the current real-time log\n\t\t\t\t\tconfiguration.
Locally modify the parameters in the real-time log configuration that you want\n\t\t\t\t\tto update.
\nCall this API (UpdateRealtimeLogConfig) by providing the entire\n\t\t\t\t\treal-time log configuration, including the parameters that you modified and\n\t\t\t\t\tthose that you didn't.
You cannot update a real-time log configuration's Name or\n\t\t\t\tARN.
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's Name or ARN.
Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
" + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" } }, "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "A list of fields to include in each real-time log record.
\nFor more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
" } }, "Name": { @@ -22993,7 +22993,7 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. You\n\t\t\tmust provide an integer between 1 and 100, inclusive.
" + "smithy.api#documentation": "The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
" } } }, @@ -23059,7 +23059,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a response headers policy.
\nWhen you update a response headers policy, the entire policy is replaced. You cannot\n\t\t\tupdate some policy fields independent of others. To update a response headers policy\n\t\t\tconfiguration:
\nUse GetResponseHeadersPolicyConfig to get the current policy's\n\t\t\t\t\tconfiguration.
Modify the fields in the response headers policy configuration that you want\n\t\t\t\t\tto update.
\nCall UpdateResponseHeadersPolicy, providing the entire response\n\t\t\t\t\theaders policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn't.
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use GetResponseHeadersPolicyConfig to get the current policy's configuration.
Modify the fields in the response headers policy configuration that you want to update.
Call UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
The version of the response headers policy that you are updating.
\nThe version is returned in the cache policy's ETag field in the response\n\t\t\tto GetResponseHeadersPolicyConfig.
The version of the response headers policy that you are updating.
The version is returned in the cache policy's ETag field in the response to GetResponseHeadersPolicyConfig.
The value of the ETag header that you received when retrieving the\n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.
The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The ID of the distribution tenant.
", + "smithy.api#documentation": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", "smithy.api#required": {} } } @@ -23512,50 +23512,50 @@ "CloudFrontDefaultCertificate": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, set this field to\n\t\t\ttrue.
If the distribution uses Aliases (alternate domain names or CNAMEs), set\n\t\t\tthis field to false and specify values for the following fields:
\n ACMCertificateArn or IAMCertificateId (specify a\n\t\t\t\t\tvalue for one, not both)
\n MinimumProtocolVersion\n
\n SSLSupportMethod\n
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
MinimumProtocolVersion
SSLSupportMethod
If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for\n\t\t\t\tMinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name\n\t\t\t(ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East\n\t\t\t(N. Virginia) Region (us-east-1).
If you specify an ACM certificate ARN, you must also specify values for\n\t\t\t\tMinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify which viewers the distribution accepts HTTPS connections from.
\n sni-only \u2013 The distribution accepts HTTPS connections from only\n\t\t\t\t\tviewers that support server name\n\t\t\t\t\t\tindication (SNI). This is recommended. Most browsers and clients\n\t\t\t\t\tsupport SNI.
\n vip \u2013 The distribution accepts HTTPS connections from all viewers\n\t\t\t\t\tincluding those that don't support SNI. This is not recommended, and results in\n\t\t\t\t\tadditional monthly charges from CloudFront.
\n static-ip - Do not specify this value unless your distribution\n\t\t\t\t\thas been enabled for this feature by the CloudFront team. If you have a use case\n\t\t\t\t\tthat requires static IP addresses for a distribution, contact CloudFront through\n\t\t\t\t\tthe Amazon Web Services Support Center.
If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, don't set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only \u2013 The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
vip \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web ServicesSupport Center.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don't set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront can use to communicate with\n\t\t\t\t\tviewers.
\nThe ciphers that CloudFront can use to encrypt the content that it returns to\n\t\t\t\t\tviewers.
\nFor more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.
\nOn the CloudFront console, this setting is called Security\n\t\t\t\t\tPolicy.
\nWhen you're using SNI only (you set SSLSupportMethod to\n\t\t\t\tsni-only), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net (you set\n\t\t\t\tCloudFrontDefaultCertificate to true), CloudFront automatically\n\t\t\tsets the security policy to TLSv1 regardless of the value that you set\n\t\t\there.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
On the CloudFront console, this setting is called Security Policy.
When you're using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
This field is deprecated. Use one of the following fields instead:
\n\n ACMCertificateArn\n
\n IAMCertificateId\n
\n CloudFrontDefaultCertificate\n
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
This field is deprecated. Use one of the following fields instead:
\n\n ACMCertificateArn\n
\n IAMCertificateId\n
\n CloudFrontDefaultCertificate\n
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.
\nIf the distribution doesn't use Aliases (also known as alternate domain\n\t\t\tnames or CNAMEs)\u2014that is, if the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net\u2014set\n\t\t\t\tCloudFrontDefaultCertificate to true and leave all other\n\t\t\tfields empty.
If the distribution uses Aliases (alternate domain names or CNAMEs), use\n\t\t\tthe fields in this type to specify the following settings:
Which viewers the distribution accepts HTTPS connections from: only viewers\n\t\t\t\t\tthat support server name indication (SNI) (recommended), or all viewers\n\t\t\t\t\tincluding those that don't support SNI.
\nTo accept HTTPS connections from only viewers that support SNI, set\n\t\t\t\t\t\t\t\tSSLSupportMethod to sni-only. This is\n\t\t\t\t\t\t\trecommended. Most browsers and clients support SNI.
To accept HTTPS connections from all viewers, including those that\n\t\t\t\t\t\t\tdon't support SNI, set SSLSupportMethod to\n\t\t\t\t\t\t\tvip. This is not recommended, and results in additional\n\t\t\t\t\t\t\tmonthly charges from CloudFront.
The minimum SSL/TLS protocol version that the distribution can use to\n\t\t\t\t\tcommunicate with viewers. To specify a minimum version, choose a value for\n\t\t\t\t\t\tMinimumProtocolVersion. For more information, see Security Policy in the\n\t\t\t\t\t\tAmazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, Certificate Manager\n\t\t\t\t\t\t(ACM) (recommended) or Identity and Access Management (IAM). You specify the location by\n\t\t\t\t\tsetting a value in one of the following fields (not both):
\n\n ACMCertificateArn\n
\n IAMCertificateId\n
All distributions support HTTPS connections from viewers. To require viewers to use\n\t\t\tHTTPS only, or to redirect them from HTTP to HTTPS, use\n\t\t\t\tViewerProtocolPolicy in the CacheBehavior or\n\t\t\t\tDefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to\n\t\t\tcommunicate with your custom origin, use CustomOriginConfig.
For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the\n\t\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
If the distribution doesn't use Aliases (also known as alternate domain names or CNAMEs)\u2014that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net\u2014set CloudFrontDefaultCertificate to true and leave all other fields empty.
If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:
Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don't support SNI.
To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.
To accept HTTPS connections from all viewers, including those that don't support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.
The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, Certificate Manager (ACM) (recommended) or Identity and Access Management (IAM). You specify the location by setting a value in one of the following fields (not both):
ACMCertificateArn
IAMCertificateId
All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.
For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#ViewerProtocolPolicy": { @@ -23644,13 +23644,13 @@ "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is\n\t\t\talso known as the origin response timeout. The minimum timeout is 1\n\t\t\tsecond, the maximum is 60 seconds, and the default (if you don't specify otherwise) is\n\t\t\t30 seconds.
\nFor more information, see Response timeout (custom origins only) in the\n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
For more information, see Response timeout (custom origins only) in the Amazon CloudFront Developer Guide.
" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The\n\t\t\tminimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't\n\t\t\tspecify otherwise) is 5 seconds.
\nFor more information, see Keep-alive timeout (custom origins only) in the\n\t\t\tAmazon CloudFront Developer Guide.
" + "smithy.api#documentation": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.
For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.
" } } }, @@ -23730,7 +23730,7 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "A flag that indicates whether more VPC origins remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\tMarker request parameter to retrieve more VPC origins in the\n\t\t\tlist.
A flag that indicates whether more VPC origins remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more VPC origins in the list.
Lists the specified log groups. You can list all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.
\nCloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the \n aws:ResourceTag/key-name\n condition key. Other CloudWatch Logs actions\n do support the use of the aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", + "smithy.api#documentation": "Returns information about log groups. You can return all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.
\nCloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the \n aws:ResourceTag/key-name\n condition key. Other CloudWatch Logs actions\n do support the use of the aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3204,13 +3204,25 @@ ] } }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { "type": "structure", "members": { "accountIdentifiers": { "target": "com.amazonaws.cloudwatchlogs#AccountIds", "traits": { - "smithy.api#documentation": "When includeLinkedAccounts is set to True, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
When includeLinkedAccounts is set to true, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
If you are using a monitoring account, set this to True to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
If you are using a monitoring account, set this to true to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
Specifies the log group class for this log group. There are three classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or \n Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as\n CloudWatch Logs Insights queries.
For details about the features supported by each class, see \n Log classes\n
" + "smithy.api#documentation": "Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups \n of all classes can be returned.
\nSpecifies the log group class for this log group. There are three classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or \n Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as\n CloudWatch Logs Insights queries.
For details about the features supported by each class, see \n Log classes\n
" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.
If you are using this operation in a monitoring account, you can specify \n the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only \n log group names in the same account as the operation.
" } } }, @@ -3260,7 +3278,7 @@ "logGroups": { "target": "com.amazonaws.cloudwatchlogs#LogGroups", "traits": { - "smithy.api#documentation": "The log groups.
\nIf the retentionInDays value is not included for a log group, then that log\n group's events do not expire.
An array of structures, where each structure contains the information about one log group.
" } }, "nextToken": { @@ -4458,7 +4476,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists log events from the specified log group. You can list all the log events or filter the results\n using one or more of the following:
\nA filter pattern
\nA time range
\nThe log stream name, or a log stream name prefix that matches mutltiple log streams
\nYou must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
\n FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. \n For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages\n don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent\n FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
If you set startFromHead to true and you don\u2019t include endTime in your request, you can end up in a situation where the pagination doesn't terminate. \n This can happen when the new log events are being added to the target log streams\n faster than they are being read. This situation is a good use case for the CloudWatch Logs Live Tail feature.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
\nIf you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they \n were transformed. To view the transformed versions, you must use a CloudWatch Logs query.\n
Lists log events from the specified log group. You can list all the log events or filter the results\n using one or more of the following:
\nA filter pattern
\nA time range
\nThe log stream name, or a log stream name prefix that matches mutltiple log streams
\nYou must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
\n FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. \n For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages\n don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent\n FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
\nIf you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they \n were transformed. To view the transformed versions, you must use a CloudWatch Logs query.\n
The grok pattern to match against the log event. For a list of \n supported grok patterns, see Supported grok patterns.
", + "smithy.api#documentation": "The grok pattern to match against the log event. For a list of \n supported grok patterns, see Supported grok patterns.
", "smithy.api#required": {} } } @@ -5578,7 +5596,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 512 } } }, @@ -6083,6 +6101,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#ListLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { "type": "operation", "input": { @@ -6164,6 +6191,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#ListLogGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can \n choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account \n observability to set up monitoring accounts and source accounts, see \n \n CloudWatch cross-account observability.
\nYou can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.
\nThis operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return\n more results.
" + } + }, "com.amazonaws.cloudwatchlogs#ListLogGroupsForQuery": { "type": "operation", "input": { @@ -6246,6 +6293,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsRequest": { + "type": "structure", + "members": { + "logGroupNamePattern": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNameRegexPattern", + "traits": { + "smithy.api#documentation": "Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter\n is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.
\nUse ^ to match log group names by prefix.
For a substring match, specify the string to match. All matches are case sensitive
\nTo match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery\n
You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times,\n and include the | symbol as many as four times.
Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups \n of all classes can be returned.
" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "If you are using a monitoring account, set this to true to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n \n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
When includeLinkedAccounts is set to true, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogGroupsResponse": { + "type": "structure", + "members": { + "logGroups": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupSummaries", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure contains the information about one log group.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatchlogs#ListTagsForResource": { "type": "operation", "input": { @@ -6400,7 +6505,7 @@ } }, "traits": { - "smithy.api#documentation": "This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
\nFor more information about this processor including examples, see \n listToMap in the CloudWatch Logs User Guide.
" + "smithy.api#documentation": "This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
\nFor more information about this processor including examples, see \n listToMap in the CloudWatch Logs User Guide.
" } }, "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": { @@ -6730,12 +6835,54 @@ "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]*$" } }, + "com.amazonaws.cloudwatchlogs#LogGroupNameRegexPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 129 + }, + "smithy.api#pattern": "^(\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24})(\\|\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24}){0,4}$" + } + }, "com.amazonaws.cloudwatchlogs#LogGroupNames": { "type": "list", "member": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName" } }, + "com.amazonaws.cloudwatchlogs#LogGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupSummary" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupSummary": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
" + } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log group.
" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "The log group class for this log group. For details about the features supported by each log group class, see \n Log classes\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one log group in your account.
" + } + }, "com.amazonaws.cloudwatchlogs#LogGroups": { "type": "list", "member": { @@ -7038,6 +7185,9 @@ { "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogGroups" + }, { "target": "com.amazonaws.cloudwatchlogs#ListLogGroupsForQuery" }, @@ -11352,6 +11502,15 @@ "smithy.api#documentation": "Use this processor to split a field into an array of strings using a delimiting character.
\nFor more information about this processor including examples, see \n splitString in the CloudWatch Logs User Guide.
" } }, + "com.amazonaws.cloudwatchlogs#SplitStringDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.cloudwatchlogs#SplitStringEntries": { "type": "list", "member": { @@ -11375,7 +11534,7 @@ } }, "delimiter": { - "target": "com.amazonaws.cloudwatchlogs#Delimiter", + "target": "com.amazonaws.cloudwatchlogs#SplitStringDelimiter", "traits": { "smithy.api#documentation": "The separator characters to split the string entry on.
", "smithy.api#required": {} diff --git a/models/codebuild/service/2016-10-06/codebuild-2016-10-06.json b/models/codebuild/service/2016-10-06/codebuild-2016-10-06.json index 8210ed6d..7380173e 100644 --- a/models/codebuild/service/2016-10-06/codebuild-2016-10-06.json +++ b/models/codebuild/service/2016-10-06/codebuild-2016-10-06.json @@ -3245,14 +3245,14 @@ "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
", + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families\n in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
", "smithy.api#required": {} } }, "computeConfiguration": { "target": "com.amazonaws.codebuild#ComputeConfiguration", "traits": { - "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
Information about the compute resources the docker server uses. Available values\n include:
\n\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n your docker server.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n your docker server.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n your docker server.
\n BUILD_GENERAL1_XLARGE: Use up to 64 GiB memory and 32 vCPUs for\n your docker server.
\n BUILD_GENERAL1_2XLARGE: Use up to 128 GiB memory and 64 vCPUs for\n your docker server.
A list of one or more security groups IDs.
\nSecurity groups configured for Docker servers should allow ingress network traffic from the VPC configured in the project. They should allow ingress on port 9876.
\nA DockerServerStatus object to use for this docker server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains docker server information.
" + } + }, + "com.amazonaws.codebuild#DockerServerStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "The status of the docker server.
" + } + }, + "message": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "A message associated with the status of a docker server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the status of the docker server.
" + } + }, "com.amazonaws.codebuild#EnvironmentImage": { "type": "structure", "members": { @@ -4531,13 +4578,13 @@ "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families\n in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" } }, "computeConfiguration": { "target": "com.amazonaws.codebuild#ComputeConfiguration", "traits": { - "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
The type of credentials CodeBuild uses to pull images in your build. There are two valid\n values:
\n\n CODEBUILD specifies that CodeBuild uses its own credentials.\n This requires that you modify your ECR repository policy to trust CodeBuild service principal.
\n SERVICE_ROLE specifies that CodeBuild uses your build project's service\n role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.\n
" } + }, + "dockerServer": { + "target": "com.amazonaws.codebuild#DockerServer", + "traits": { + "smithy.api#documentation": "A DockerServer object to use for this build project.
" + } } }, "traits": { @@ -9853,13 +9906,13 @@ "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" + "smithy.api#documentation": "Information about the compute resources the compute fleet uses. Available values\n include:
\n\n ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild \n will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment \n types in the CodeBuild User Guide.
\n CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families\n in the CodeBuild User Guide.
\n BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for\n builds.
\n BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for\n builds.
\n BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for\n builds, depending on your environment type.
\n BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.
\n BUILD_LAMBDA_1GB: Use up to 1 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_2GB: Use up to 2 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_4GB: Use up to 4 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_8GB: Use up to 8 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
\n BUILD_LAMBDA_10GB: Use up to 10 GiB memory for\n builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16\n GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB\n memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB\n memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types \n in the CodeBuild User Guide.\n
" } }, "computeConfiguration": { "target": "com.amazonaws.codebuild#ComputeConfiguration", "traits": { - "smithy.api#documentation": "The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
Input information used for an action execution.
" } }, + "com.amazonaws.codepipeline#ActionExecutionNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codepipeline#Message" + } + }, + "traits": { + "smithy.api#documentation": "The action execution was not found.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.codepipeline#ActionExecutionOutput": { "type": "structure", "members": { @@ -1727,7 +1739,7 @@ } }, "traits": { - "smithy.api#documentation": "The conditions for making checks for entry to a stage. For more information about conditions, see Stage\n conditions and How do stage conditions work?.
" + "smithy.api#documentation": "The conditions for making checks for entry to a stage. For more information about\n conditions, see Stage conditions\n and How do\n stage conditions work?.
" } }, "com.amazonaws.codepipeline#BlockerDeclaration": { @@ -1864,6 +1876,9 @@ { "target": "com.amazonaws.codepipeline#ListActionTypes" }, + { + "target": "com.amazonaws.codepipeline#ListDeployActionExecutionTargets" + }, { "target": "com.amazonaws.codepipeline#ListPipelineExecutions" }, @@ -2961,7 +2976,7 @@ } }, "traits": { - "smithy.api#documentation": "The condition for the stage. A condition is made up of the rules and the result for\n the condition. For more information about conditions, see Stage\n conditions and How do stage conditions work?..\n For more information about rules, see the CodePipeline rule\n reference.
" + "smithy.api#documentation": "The condition for the stage. A condition is made up of the rules and the result for\n the condition. For more information about conditions, see Stage conditions\n and How do\n stage conditions work?.. For more information about rules, see the CodePipeline rule reference.
" } }, "com.amazonaws.codepipeline#ConditionExecution": { @@ -3488,6 +3503,120 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#DeployActionExecutionTarget": { + "type": "structure", + "members": { + "targetId": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The ID of the target for the deploy action.
" + } + }, + "targetType": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The type of target for the deploy action.
" + } + }, + "status": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The status of the deploy action.
" + } + }, + "startTime": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "The start time for the deploy action.
" + } + }, + "endTime": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "The end time for the deploy action.
" + } + }, + "events": { + "target": "com.amazonaws.codepipeline#DeployTargetEventList", + "traits": { + "smithy.api#documentation": "The lifecycle events for the deploy action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target for the deploy action.
" + } + }, + "com.amazonaws.codepipeline#DeployActionExecutionTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#DeployActionExecutionTarget" + } + }, + "com.amazonaws.codepipeline#DeployTargetEvent": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The name of the event for the deploy action.
" + } + }, + "status": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The status of the event for the deploy action.
" + } + }, + "startTime": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "The start time for the event for the deploy action.
" + } + }, + "endTime": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "The end time for the event for the deploy action.
" + } + }, + "context": { + "target": "com.amazonaws.codepipeline#DeployTargetEventContext", + "traits": { + "smithy.api#documentation": "The context for the event for the deploy action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A lifecycle event for the deploy action.
" + } + }, + "com.amazonaws.codepipeline#DeployTargetEventContext": { + "type": "structure", + "members": { + "ssmCommandId": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The command ID for the event for the deploy action.
" + } + }, + "message": { + "target": "com.amazonaws.codepipeline#String", + "traits": { + "smithy.api#documentation": "The context message for the event for the deploy action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The context for the event for the deploy action.
" + } + }, + "com.amazonaws.codepipeline#DeployTargetEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#DeployTargetEvent" + } + }, "com.amazonaws.codepipeline#DeregisterWebhookWithThirdParty": { "type": "operation", "input": { @@ -3737,6 +3866,12 @@ "smithy.api#documentation": "The environment variable value in the key-value pair.
", "smithy.api#required": {} } + }, + "type": { + "target": "com.amazonaws.codepipeline#EnvironmentVariableType", + "traits": { + "smithy.api#documentation": "Specifies the type of use for the environment variable value. The value can be either\n PLAINTEXT or SECRETS_MANAGER. If the value is SECRETS_MANAGER, provide the Secrets\n reference in the EnvironmentVariable value.
The conditions that are configured as failure conditions. For more information about conditions, see Stage\n conditions and How do stage conditions work?.
" + "smithy.api#documentation": "The conditions that are configured as failure conditions. For more information about\n conditions, see Stage conditions\n and How do\n stage conditions work?.
" } } }, "traits": { - "smithy.api#documentation": "The configuration that specifies the result, such as rollback, to occur upon stage\n failure. For more information about conditions, see Stage\n conditions and How do stage conditions work?.
" + "smithy.api#documentation": "The configuration that specifies the result, such as rollback, to occur upon stage\n failure. For more information about conditions, see Stage conditions\n and How do\n stage conditions work?.
" } }, "com.amazonaws.codepipeline#FailureDetails": { @@ -5404,6 +5556,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#ListDeployActionExecutionTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.codepipeline#ListDeployActionExecutionTargetsInput" + }, + "output": { + "target": "com.amazonaws.codepipeline#ListDeployActionExecutionTargetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codepipeline#ActionExecutionNotFoundException" + }, + { + "target": "com.amazonaws.codepipeline#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.codepipeline#PipelineNotFoundException" + }, + { + "target": "com.amazonaws.codepipeline#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the targets for the deploy action.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "targets", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.codepipeline#ListDeployActionExecutionTargetsInput": { + "type": "structure", + "members": { + "pipelineName": { + "target": "com.amazonaws.codepipeline#PipelineName", + "traits": { + "smithy.api#documentation": "The name of the pipeline with the deploy action.
" + } + }, + "actionExecutionId": { + "target": "com.amazonaws.codepipeline#ActionExecutionId", + "traits": { + "smithy.api#documentation": "The execution ID for the deploy action.
", + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.codepipeline#TargetFilterList", + "traits": { + "smithy.api#documentation": "Filters the targets for a specified deploy action.
" + } + }, + "maxResults": { + "target": "com.amazonaws.codepipeline#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.
" + } + }, + "nextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous list action types call, which can be\n used to return the next set of action types in the list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codepipeline#ListDeployActionExecutionTargetsOutput": { + "type": "structure", + "members": { + "targets": { + "target": "com.amazonaws.codepipeline#DeployActionExecutionTargetList", + "traits": { + "smithy.api#documentation": "The targets for the deploy action.
" + } + }, + "nextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous list action types call, which can be\n used to return the next set of action types in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.codepipeline#ListPipelineExecutions": { "type": "operation", "input": { @@ -5671,7 +5914,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the rules for the condition. For more information about conditions, see Stage\n conditions and How do stage conditions work?.For more information about rules, see the CodePipeline rule reference.
" + "smithy.api#documentation": "Lists the rules for the condition. For more information about conditions, see Stage\n conditions and How do\n stage conditions work?.For more information about rules, see the CodePipeline rule reference.
" } }, "com.amazonaws.codepipeline#ListRuleTypesInput": { @@ -6142,7 +6385,7 @@ } ], "traits": { - "smithy.api#documentation": "Used to override a stage condition. For more information about conditions, see Stage\n conditions and How do stage conditions work?.
" + "smithy.api#documentation": "Used to override a stage condition. For more information about conditions, see Stage\n conditions and How do\n stage conditions work?.
" } }, "com.amazonaws.codepipeline#OverrideStageConditionInput": { @@ -6595,7 +6838,7 @@ "pollingDisabledAt": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that polling for source changes (periodic checks) was stopped for\n the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use\n event-based change detection. For example, for a pipeline with a CodeCommit\n source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To\n learn more, see Migrate polling\n pipelines to use event-based change detection in the CodePipeline\n User Guide.
" + "smithy.api#documentation": "The date and time that polling for source changes (periodic checks) was stopped for\n the pipeline, in timestamp format.
\nPipelines that are inactive for longer than 30 days will have polling disabled for\n the pipeline. For more information, see pollingDisabledAt in the pipeline structure reference. For the steps to\n migrate your pipeline from polling to event-based change detection, see Migrate polling\n pipelines to use event-based change detection.
\nYou can migrate (update) a polling pipeline to use event-based change detection. For\n example, for a pipeline with a CodeCommit source, we recommend you migrate\n (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling\n pipelines to use event-based change detection in the CodePipeline User Guide.
" } } }, @@ -8166,7 +8409,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents information about the rule to be created for an associated condition. An\n example would be creating a new rule for an entry condition, such as a rule that checks\n for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage\n conditions and How do stage conditions work?.\n For more information about rules, see the CodePipeline rule\n reference.
" + "smithy.api#documentation": "Represents information about the rule to be created for an associated condition. An\n example would be creating a new rule for an entry condition, such as a rule that checks\n for a test result before allowing the run to enter the deployment stage. For more\n information about conditions, see Stage conditions\n and How do\n stage conditions work?. For more information about rules, see the CodePipeline rule reference.
" } }, "com.amazonaws.codepipeline#RuleDeclarationList": { @@ -8352,7 +8595,7 @@ "ruleTypeId": { "target": "com.amazonaws.codepipeline#RuleTypeId", "traits": { - "smithy.api#documentation": "The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version. For more\n information about conditions, see Stage conditions.\n For more information about rules, see the CodePipeline rule\n reference.
" + "smithy.api#documentation": "The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version. For more information about conditions, see Stage\n conditions. For more information about rules, see the CodePipeline rule reference.
" } }, "configuration": { @@ -8637,7 +8880,7 @@ "provider": { "target": "com.amazonaws.codepipeline#RuleProvider", "traits": { - "smithy.api#documentation": "The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the CodePipeline rule\n reference.
The rule provider, such as the DeploymentWindow rule. For a list of rule\n provider names, see the rules listed in the CodePipeline rule\n reference.
The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version. For more\n information about conditions, see Stage conditions.\n For more information about rules, see the CodePipeline rule\n reference.
" + "smithy.api#documentation": "The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version. For more information about conditions, see Stage\n conditions. For more information about rules, see the CodePipeline rule reference.
" } }, "com.amazonaws.codepipeline#RuleTypeList": { @@ -9447,7 +9690,7 @@ } }, "traits": { - "smithy.api#documentation": "The conditions for making checks that, if met, succeed a stage. For more information about conditions, see Stage\n conditions and How do stage conditions work?.
" + "smithy.api#documentation": "The conditions for making checks that, if met, succeed a stage. For more information\n about conditions, see Stage conditions\n and How do\n stage conditions work?.
" } }, "com.amazonaws.codepipeline#Tag": { @@ -9563,6 +9806,57 @@ } } }, + "com.amazonaws.codepipeline#TargetFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.codepipeline#TargetFilterName", + "traits": { + "smithy.api#documentation": "The name on which to filter.
" + } + }, + "values": { + "target": "com.amazonaws.codepipeline#TargetFilterValueList", + "traits": { + "smithy.api#documentation": "The values on which to filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filters the list of targets.
" + } + }, + "com.amazonaws.codepipeline#TargetFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#TargetFilter" + } + }, + "com.amazonaws.codepipeline#TargetFilterName": { + "type": "enum", + "members": { + "TARGET_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET_STATUS" + } + } + } + }, + "com.amazonaws.codepipeline#TargetFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codepipeline#TargetFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#TargetFilterValue" + } + }, "com.amazonaws.codepipeline#ThirdPartyJob": { "type": "structure", "members": { diff --git a/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json b/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json index 636bce5b..6a965ebb 100644 --- a/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json +++ b/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json @@ -8164,11 +8164,17 @@ { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { @@ -12550,8 +12556,14 @@ { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { diff --git a/models/controltower/service/2018-05-10/controltower-2018-05-10.json b/models/controltower/service/2018-05-10/controltower-2018-05-10.json index e31956a4..11caab9c 100644 --- a/models/controltower/service/2018-05-10/controltower-2018-05-10.json +++ b/models/controltower/service/2018-05-10/controltower-2018-05-10.json @@ -67,7 +67,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "Amazon Web Services Control Tower offers application programming interface (API)\n operations that support programmatic interaction with these types of resources:
\n\n \n Controls\n \n
\n\n DisableControl\n
\n\n EnableControl\n
\n\n GetEnabledControl\n
\n\n ListEnabledControls\n
\n\n UpdateEnabledControl\n
\n\n \n Landing\n zones\n \n
\n\n CreateLandingZone\n
\n\n DeleteLandingZone\n
\n\n GetLandingZone\n
\n\n ListLandingZones\n
\n\n ResetLandingZone\n
\n\n UpdateLandingZone\n
\n\n \n Baselines\n \n
\n\n DisableBaseline\n
\n\n EnableBaseline\n
\n\n GetBaseline\n
\n\n GetBaselineOperation\n
\n\n GetEnabledBaseline\n
\n\n ListBaselines\n
\n\n ListEnabledBaselines\n
\n\n ResetEnabledBaseline\n
\n\n \n Tagging\n \n
\n\n ListTagsForResource\n
\n\n TagResource\n
\n\n UntagResource\n
\nFor more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .
\n\n About control APIs\n
\nThese interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
\nTo call these APIs, you'll need to know:
\nthe controlIdentifier for the control--or guardrail--you are\n targeting.
the ARN associated with the target organizational unit (OU), which we call the\n targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
\n\n To get the controlIdentifier for your Amazon Web Services Control Tower control:\n
The controlIdentifier is an ARN that is specified for each control. You can\n view the controlIdentifier in the console on the Control\n details page, as well as in the documentation.
\n About identifiers for Amazon Web Services Control Tower\n
\nThe Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each\n control. You can find the controlIdentifier for each Region and control in the\n Tables of control metadata or the Control\n availability by Region tables in the Amazon Web Services Control Tower\n Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower\n legacy Strongly recommended and Elective controls\n is given in Resource\n identifiers for APIs and controls in the \n Amazon Web Services Control Tower Controls Reference Guide\n . Remember\n that Mandatory controls cannot be added or removed.
\n\n Some controls have two identifiers\n
\n\n ARN format for Amazon Web Services Control\n Tower:\n arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}\n
\n Example:\n
\n\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n
\n ARN format for Amazon Web Services Control\n Catalog:\n arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}\n
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the \n Amazon Web Services Control Tower Controls Reference\n Guide\n , or in the Amazon Web Services Control Tower console, on the\n Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as\n GetEnabledControl and ListEnabledControls always return an\n ARN of the same type given when the control was enabled.
\n To get the targetIdentifier:\n
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the\n Organizational unit details page associated with that\n OU.
\n\n OU ARN format:\n
\n\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n
\n About landing zone APIs\n
\nYou can configure and launch an Amazon Web Services Control Tower landing zone with APIs.\n For an introduction and steps, see Getting started with\n Amazon Web Services Control Tower using APIs.
\nFor an overview of landing zone API operations, see \n Amazon Web Services Control Tower supports landing zone APIs. The individual API\n operations for landing zones are detailed in this document, the API reference\n manual, in the \"Actions\" section.
\n\n About baseline APIs\n
\nYou can apply the AWSControlTowerBaseline baseline to an organizational\n unit (OU) as a way to register the OU with Amazon Web Services Control Tower,\n programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration\n with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services\n Control Tower enables for your landing zone, on your behalf, when setting up the landing\n zone. These baselines are read-only baselines.
\nThe individual API operations for baselines are detailed in this document, the API\n reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
\n\n About Amazon Web Services Control Catalog identifiers\n
\nThe EnableControl and DisableControl API operations can\n be called by specifying either the Amazon Web Services Control Tower identifer or the\n Amazon Web Services Control Catalog identifier. The API response returns the same\n type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the\n EnableControl API, and then call EnableControl again\n with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control\n Tower returns an error message stating that the control is already enabled. Similar\n behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
\n\n Details and examples\n
\n\n Creating Amazon Web Services Control Tower resources with Amazon Web Services\n CloudFormation\n
\nTo view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n
\n\n Recording API Requests\n
\nAmazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that\n records Amazon Web Services API calls for your Amazon Web Services account and delivers log\n files to an Amazon S3 bucket. By using information collected by CloudTrail, you can\n determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its\n support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the\n Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including\n how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.
", + "smithy.api#documentation": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1187,7 +1187,7 @@ "statusMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "If the operation result is FAILED, this string contains a message explaining\n why the operation failed.
If the operation result is FAILED, this string contains a message explaining why the operation failed.
Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, \n based on the parameters specified in the manifest JSON file.
", + "smithy.api#documentation": "Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1464,7 +1464,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.
", + "smithy.api#documentation": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
", "smithy.api#required": {} } }, @@ -1493,7 +1493,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a CreateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower \n resources deployed in accounts managed by Amazon Web Services Control Tower.
", + "smithy.api#documentation": "Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1561,7 +1561,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": ">A unique identifier assigned to a DeleteLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
>A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1687,7 +1687,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days.
", + "smithy.api#documentation": "The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", "smithy.api#required": {} } } @@ -1753,12 +1753,12 @@ "driftStatus": { "target": "com.amazonaws.controltower#DriftStatus", "traits": { - "smithy.api#documentation": "The drift status of the enabled control.
\nValid values:
\n\n DRIFTED: The enabledControl deployed in this configuration\n doesn\u2019t match the configuration that Amazon Web Services Control Tower expected.
\n IN_SYNC: The enabledControl deployed in this configuration matches\n the configuration that Amazon Web Services Control Tower expected.
\n NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled\n control. Drift is not supported for the control type.
\n UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the\n enabled control.
The drift status of the enabled control.
Valid values:
DRIFTED: The enabledControl deployed in this configuration doesn\u2019t match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The enabledControl deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
NOT_CHECKING: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.
UNKNOWN: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.
The drift summary of the enabled control.
\nAmazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" + "smithy.api#documentation": "The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
" } }, "com.amazonaws.controltower#DriftStatuses": { @@ -1805,7 +1805,7 @@ } ], "traits": { - "smithy.api#documentation": "Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -1922,7 +1922,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.
The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days.
", + "smithy.api#documentation": "The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", "smithy.api#required": {} } }, @@ -2006,6 +2006,12 @@ "smithy.api#documentation": "The enabled version of the Baseline.
The drift status of the enabled baseline.
" + } + }, "targetIdentifier": { "target": "smithy.api#String", "traits": { @@ -2036,6 +2042,75 @@ "smithy.api#documentation": "Details of the EnabledBaseline resource.
The types of drift that can be detected for an enabled baseline. Amazon Web Services Control Tower detects inheritance drift on enabled baselines that apply at the OU level.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The drift summary of the enabled baseline. Amazon Web Services Control Tower reports inheritance drift when an enabled baseline configuration of a member account is different than the configuration that applies to the OU. Amazon Web Services Control Tower reports this type of drift for a parent or child enabled baseline. One way to repair this drift by resetting the parent enabled baseline, on the OU.
For example, you may see this type of drift if you move accounts between OUs, but the accounts are not yet (re-)enrolled.
" + } + }, + "com.amazonaws.controltower#EnabledBaselineDriftStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledBaselineDriftStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.controltower#EnabledBaselineDriftTypes": { + "type": "structure", + "members": { + "inheritance": { + "target": "com.amazonaws.controltower#EnabledBaselineInheritanceDrift", + "traits": { + "smithy.api#documentation": "At least one account within the target OU does not match the baseline configuration defined on that OU. An account is in inheritance drift when it does not match the configuration of a parent OU, possibly a new parent OU, if the account is moved.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The types of drift that can be detected for an enabled baseline.
Amazon Web Services Control Tower detects inheritance drift on the enabled baselines that target OUs: AWSControlTowerBaseline and BackupBaseline.
Amazon Web Services Control Tower does not detect drift on the baselines that apply to your landing zone: IdentityCenterBaseline, AuditBaseline, LogArchiveBaseline, BackupCentralVaultBaseline, or BackupAdminBaseline. For more information, see Types of baselines.
Baselines enabled on an OU are inherited by its member accounts as child EnabledBaseline resources. The baseline on the OU serves as the parent EnabledBaseline, which governs the configuration of each child EnabledBaseline.
If the baseline configuration of a member account in an OU does not match the configuration of the parent OU, the parent and child baseline is in a state of inheritance drift. This drift could occur in the AWSControlTowerBaseline or the BackupBaseline related to that account.
An optional filter that sets up a list of parentIdentifiers to filter the results of the ListEnabledBaseline output.
A list of EnablementStatus items.
A list of EnabledBaselineDriftStatus items for enabled baselines.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The inheritance drift status for enabled baselines.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The inheritance drift summary for the enabled baseline. Inheritance drift occurs when any accounts in the target OU do not match the baseline configuration defined on that OU.
" + } + }, "com.amazonaws.controltower#EnabledBaselineParameter": { "type": "structure", "members": { @@ -2189,6 +2290,12 @@ "smithy.api#documentation": "The enabled version of the baseline.
" } }, + "driftStatusSummary": { + "target": "com.amazonaws.controltower#EnabledBaselineDriftStatusSummary", + "traits": { + "smithy.api#documentation": "The drift status of the enabled baseline.
" + } + }, "targetIdentifier": { "target": "smithy.api#String", "traits": { @@ -2473,7 +2580,7 @@ "status": { "target": "com.amazonaws.controltower#EnablementStatus", "traits": { - "smithy.api#documentation": "The deployment status of the enabled resource.
\nValid values:
\n\n SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
\n UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
\n FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
The deployment status of the enabled resource.
Valid values:
SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or\n DisableControl operation. Displays a message in case of error. Details for an\n operation are available for 90 days. For usage examples, see the \n Controls Reference Guide\n .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days.
", + "smithy.api#documentation": "The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", "smithy.api#required": {} } } @@ -2797,7 +2904,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves details about an enabled control. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2912,7 +3019,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the status of the specified landing zone operation. Details for an operation are available for \n 90 days.
", + "smithy.api#documentation": "Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3052,12 +3159,12 @@ "status": { "target": "com.amazonaws.controltower#LandingZoneDriftStatus", "traits": { - "smithy.api#documentation": "The drift status of the landing zone.
\nValid values:
\n\n DRIFTED: The landing zone deployed in this configuration does not match the \n configuration that Amazon Web Services Control Tower expected.
\n IN_SYNC: The landing zone deployed in this configuration matches the \n configuration that Amazon Web Services Control Tower expected.
The drift status of the landing zone.
Valid values:
DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.
IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.
The drift status summary of the landing zone.
\nIf the landing zone differs from the expected configuration, it is defined to be in a state of \n drift. You can repair this drift by resetting the landing zone.
" + "smithy.api#documentation": "The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
" } }, "com.amazonaws.controltower#LandingZoneOperationDetail": { @@ -3066,7 +3173,7 @@ "operationType": { "target": "com.amazonaws.controltower#LandingZoneOperationType", "traits": { - "smithy.api#documentation": "The landing zone operation type.
\nValid values:
\n\n DELETE: The DeleteLandingZone operation.
\n CREATE: The CreateLandingZone operation.
\n UPDATE: The UpdateLandingZone operation.
\n RESET: The ResetLandingZone operation.
The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
Valid values:
\n\n SUCCEEDED: The landing zone operation succeeded.
\n IN_PROGRESS: The landing zone operation is in progress.
\n FAILED: The landing zone operation failed.
Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
Returns a summary list of all available baselines. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
", + "smithy.api#documentation": "Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3405,7 +3512,7 @@ "baselines": { "target": "com.amazonaws.controltower#Baselines", "traits": { - "smithy.api#documentation": "A list of Baseline object details.
A list of Baseline object details.
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
A value that can be set to include the child enabled baselines in responses. The default value is false.
" + "smithy.api#documentation": "A value that can be set to include the child enabled baselines in responses. The default value is false.
" } } }, @@ -3653,7 +3760,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and\n the accounts it contains. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3707,14 +3814,14 @@ "enabledControls": { "target": "com.amazonaws.controltower#EnabledControls", "traits": { - "smithy.api#documentation": "Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and\n the accounts it contains.
", + "smithy.api#documentation": "Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the response is the\n end of the results.
" + "smithy.api#documentation": "Retrieves the next page of results. If the string is empty, the response is the end of the results.
" } } }, @@ -3839,7 +3946,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also \n creates an ARN for existing accounts that do not yet have a landing zone ARN.
\nReturns one landing zone ARN.
", + "smithy.api#documentation": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -3928,7 +4035,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of tags associated with the resource. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 200, "method": "GET", @@ -4001,7 +4108,7 @@ } }, "traits": { - "smithy.api#documentation": "An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
\nThe expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.
" + "smithy.api#documentation": "An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
" } }, "com.amazonaws.controltower#RegionName": { @@ -4045,7 +4152,7 @@ } ], "traits": { - "smithy.api#documentation": "Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call resets a landing zone. It starts an asynchronous operation that resets the\n landing zone to the parameters specified in the original configuration, which you specified\n in the manifest file. Nothing in the manifest file's original landing zone configuration is changed\n during the reset process, by default. This API is not the same as a rollback of a landing\n zone version, which is not a supported operation.
", + "smithy.api#documentation": "This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -4211,7 +4318,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a ResetLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", + "smithy.api#documentation": "The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4308,7 +4415,7 @@ } ], "traits": { - "smithy.api#documentation": "Applies tags to a resource. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "Applies tags to a resource. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 204, "method": "POST", @@ -4466,7 +4573,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from a resource. For usage examples, see the \n Controls Reference Guide\n .
", + "smithy.api#documentation": "Removes tags from a resource. For usage examples, see the Controls Reference Guide .
", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -4537,7 +4644,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
\n Updates the configuration of an already enabled control.
\nIf the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the \n Controls Reference Guide\n .\n
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the Controls Reference Guide .
\n The ARN of the enabled control that will be updated.\n
", + "smithy.api#documentation": "The ARN of the enabled control that will be updated.
", "smithy.api#required": {} } } @@ -4656,7 +4763,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "\n The operation identifier for this UpdateEnabledControl operation.\n
The operation identifier for this UpdateEnabledControl operation.
This API call updates the landing zone. It starts an asynchronous operation that updates the \n landing zone based on the new landing zone version, or on the changed parameters specified in the \n updated manifest file.
", + "smithy.api#documentation": "This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -4715,7 +4822,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review \n Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.
", + "smithy.api#documentation": "The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.
", "smithy.api#required": {} } }, @@ -4737,7 +4844,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier assigned to a UpdateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.
A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.
The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
", "smithy.api#required": {} @@ -6828,7 +6828,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to event subscriptions.
\nValid filter names: event-subscription-arn | event-subscription-id
" + "smithy.api#documentation": "Filters applied to event subscriptions.
\nValid filter names: event-subscription-arn | event-subscription-id\n
The name or Amazon Resource Name (ARN) for the migration project.
", "smithy.api#required": {} @@ -7565,7 +7565,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the migration project.
", "smithy.api#required": {} @@ -7669,7 +7669,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -7773,7 +7773,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -7877,7 +7877,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -7981,7 +7981,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -8334,7 +8334,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the limitations described in the form of key-value pairs.
" + "smithy.api#documentation": "Filters applied to the limitations described in the form of key-value pairs.
\nValid filter names: database-id | engine-name\n
Filters applied to the target engine recommendations described in the form of\n key-value pairs.
" + "smithy.api#documentation": "Filters applied to the target engine recommendations described in the form of\n key-value pairs.
\nValid filter names: database-id | engine-name\n
Filters applied to the replications.
" + "smithy.api#documentation": "Filters applied to the replications.
\n Valid filter names: replication-config-arn | replication-config-id\n
The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -12403,6 +12403,15 @@ "smithy.api#documentation": "Provides information that defines a migration project.
" } }, + "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.databasemigrationservice#MigrationProjectList": { "type": "list", "member": { @@ -12472,7 +12481,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -14149,6 +14158,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#MySQLAuthenticationMethod": { + "type": "enum", + "members": { + "Password": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, "com.amazonaws.databasemigrationservice#MySQLSettings": { "type": "structure", "members": { @@ -14241,6 +14267,18 @@ "traits": { "smithy.api#documentation": "Sets the client statement timeout (in seconds) for a MySQL source endpoint.
" } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
This attribute allows you to specify the authentication method as \"iam auth\".
" + } } }, "traits": { @@ -14899,6 +14937,23 @@ } } }, + "com.amazonaws.databasemigrationservice#PostgreSQLAuthenticationMethod": { + "type": "enum", + "members": { + "Password": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam" + } + } + } + }, "com.amazonaws.databasemigrationservice#PostgreSQLSettings": { "type": "structure", "members": { @@ -15051,6 +15106,18 @@ "traits": { "smithy.api#documentation": "Disables the Unicode source filter with PostgreSQL, for values passed into the Selection\n rule filter on Source Endpoint column values. By default DMS performs source filter\n comparisons using a Unicode string which can cause look ups to ignore the indexes in the\n text columns and slow down migrations.
\nUnicode support should only be disabled when using a selection rule filter is on a text\n column in the Source database that is indexed.
" } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The IAM role arn you can use to authenticate the connection to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
This attribute allows you to specify the authentication method as \"iam auth\".
" + } } }, "traits": { @@ -18168,7 +18235,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -18248,7 +18315,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -18335,7 +18402,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -18424,7 +18491,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -18525,7 +18592,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -18620,7 +18687,7 @@ "type": "structure", "members": { "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "target": "com.amazonaws.databasemigrationservice#MigrationProjectIdentifier", "traits": { "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", "smithy.api#required": {} @@ -19705,6 +19772,36 @@ "traits": { "smithy.api#documentation": "Additional details about the state of validation.
" } + }, + "ResyncState": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Records the current state of table resynchronization in the migration task.
\nThis parameter can have the following values:
\nNot enabled \u2013 Resync is not enabled for the table in the migration task.
\nPending \u2013 The tables are waiting for resync.
\nIn progress \u2013 Resync in progress for some records in the table.
\nNo primary key \u2013 The table could not be resynced because it has no primary key.
\nLast resync at: date/time \u2013 Resync session is finished at time. Time provided in UTC format.
Records the total number of mismatched data rows where the system attempted to apply\n fixes in the target database.
" + } + }, + "ResyncRowsSucceeded": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "Records the total number of mismatched data rows where fixes were successfully applied in the target database.
" + } + }, + "ResyncRowsFailed": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "Records the total number of mismatched data rows where fix attempts failed in the target\n database.
" + } + }, + "ResyncProgress": { + "target": "com.amazonaws.databasemigrationservice#DoubleOptional", + "traits": { + "smithy.api#documentation": "Calculates the percentage of failed validations that were successfully resynced to the system.
" + } } }, "traits": { diff --git a/models/datasync/service/2018-11-09/datasync-2018-11-09.json b/models/datasync/service/2018-11-09/datasync-2018-11-09.json index 7e953d4a..98380db7 100644 --- a/models/datasync/service/2018-11-09/datasync-2018-11-09.json +++ b/models/datasync/service/2018-11-09/datasync-2018-11-09.json @@ -39,106 +39,6 @@ "smithy.api#pattern": "^[A-Z0-9]{5}(-[A-Z0-9]{5}){4}$" } }, - "com.amazonaws.datasync#AddStorageSystem": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#AddStorageSystemRequest" - }, - "output": { - "target": "com.amazonaws.datasync#AddStorageSystemResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect\n information about.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#AddStorageSystemRequest": { - "type": "structure", - "members": { - "ServerConfiguration": { - "target": "com.amazonaws.datasync#DiscoveryServerConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the server name and network port required to connect with the management\n interface of your on-premises storage system.
", - "smithy.api#required": {} - } - }, - "SystemType": { - "target": "com.amazonaws.datasync#DiscoverySystemType", - "traits": { - "smithy.api#documentation": "Specifies the type of on-premises storage system that you want DataSync Discovery to collect\n information about.
\nDataSync Discovery currently supports NetApp\n Fabric-Attached\n Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or\n later.
\nSpecifies the Amazon Resource Name (ARN) of the DataSync agent that connects to\n and reads from your on-premises storage system's management interface. You can only specify\n one ARN.
", - "smithy.api#required": {} - } - }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", - "traits": { - "smithy.api#documentation": "Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging\n discovery job events.
" - } - }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services\n resources. We recommend creating at least a name tag for your on-premises storage\n system.
" - } - }, - "Name": { - "target": "com.amazonaws.datasync#Name", - "traits": { - "smithy.api#documentation": "Specifies a familiar name for your on-premises storage system.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "Specifies a client token to make sure requests with this API operation are idempotent. If\n you don't specify a client token, DataSync generates one for you\n automatically.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Credentials": { - "target": "com.amazonaws.datasync#Credentials", - "traits": { - "smithy.api#documentation": "Specifies the user name and password for accessing your on-premises storage system's\n management interface.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#AddStorageSystemResponse": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "The ARN of the on-premises storage system that you can use with DataSync Discovery.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#AgentArn": { "type": "string", "traits": { @@ -185,7 +85,7 @@ "Status": { "target": "com.amazonaws.datasync#AgentStatus", "traits": { - "smithy.api#documentation": "The status of an agent.
\nIf the status is ONLINE, the agent is configured properly and ready to\n use.
If the status is OFFLINE, the agent has been out of contact with\n DataSync for five minutes or longer. This can happen for a few reasons. For\n more information, see What do I do if my agent is offline?\n
The status of an agent.
\nIf the status is ONLINE, the agent is configured properly and ready to\n use.
If the status is OFFLINE, the agent has been out of contact with\n DataSync for five minutes or longer. This can happen for a few reasons. For\n more information, see What do I do if my agent is offline?\n
Specifies a SAS token that provides permissions to access your Azure Blob Storage.
\nThe token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:
\n\n sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D\n
Specifies a SAS token that provides permissions to access your Azure Blob Storage.
\nThe token is part of the SAS URI string that comes after the storage resource URI and a\n question mark. A token looks something like this:
\n\n sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D\n
The shared access signature (SAS) configuration that allows DataSync to access your Microsoft Azure Blob Storage.
\nFor more information, see SAS\n tokens for accessing your Azure Blob Storage.
" + "smithy.api#documentation": "The shared access signature (SAS) configuration that allows DataSync to\n access your Microsoft Azure Blob Storage.
\nFor more information, see SAS\n tokens for accessing your Azure Blob Storage.
" } }, "com.amazonaws.datasync#AzureBlobSasToken": { @@ -385,47 +285,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#Capacity": { - "type": "structure", - "members": { - "Used": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The amount of space that's being used in a storage system resource.
" - } - }, - "Provisioned": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The total amount of space available in a storage system resource.
" - } - }, - "LogicalUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The amount of space that's being used in a storage system resource without accounting for\n compression or deduplication.
" - } - }, - "ClusterCloudStorageUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" - } - } - }, - "traits": { - "smithy.api#documentation": "The storage capacity of an on-premises storage system resource (for example, a\n volume).
" - } - }, - "com.amazonaws.datasync#CollectionDurationMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 44640 - } - } - }, "com.amazonaws.datasync#CreateAgent": { "type": "operation", "input": { @@ -443,7 +302,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates an DataSync agent that you deploy in your storage environment.\n The activation process associates the agent with your Amazon Web Services account.
\nIf you haven't deployed an agent yet, see Do I need a DataSync agent?\n
" + "smithy.api#documentation": "Activates an DataSync agent that you deploy in your storage environment.\n The activation process associates the agent with your Amazon Web Services account.
\nIf you haven't deployed an agent yet, see Do I need a DataSync\n agent?\n
" } }, "com.amazonaws.datasync#CreateAgentRequest": { @@ -465,13 +324,13 @@ "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.\n We recommend creating at least one tag for your agent.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
" } }, "VpcEndpointId": { "target": "com.amazonaws.datasync#VpcEndpointId", "traits": { - "smithy.api#documentation": "Specifies the ID of the VPC service endpoint that you're using. For\n example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.
The VPC service endpoint you use must include the DataSync service name (for\n example, com.amazonaws.us-east-2.datasync).
Specifies the ID of the VPC service\n endpoint that you're using. For example, a VPC endpoint ID looks like\n vpce-01234d5aff67890e1.
The VPC service endpoint you use must include the DataSync service name (for\n example, com.amazonaws.us-east-2.datasync).
Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
", + "smithy.api#documentation": "Specifies the authentication method DataSync uses to access your Azure Blob\n Storage. DataSync can access blob storage using a shared access signature\n (SAS).
", "smithy.api#required": {} } }, "SasConfiguration": { "target": "com.amazonaws.datasync#AzureBlobSasConfiguration", "traits": { - "smithy.api#documentation": "Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
" + "smithy.api#documentation": "Specifies the SAS configuration that allows DataSync to access your Azure Blob\n Storage.
" } }, "BlobType": { @@ -559,7 +418,7 @@ "AccessTier": { "target": "com.amazonaws.datasync#AzureAccessTier", "traits": { - "smithy.api#documentation": "Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
" + "smithy.api#documentation": "Specifies the access tier that you want your objects or files transferred into. This only\n applies when using the location as a transfer destination. For more information, see Access tiers.
" } }, "Subdirectory": { @@ -571,14 +430,14 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for your transfer.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect\n with your Azure Blob Storage container.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for your transfer.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services\n resources. We recommend creating at least a name tag for your transfer location.
" } } }, @@ -626,7 +485,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or\n destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing restricted file systems.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing\n restricted file systems.
" } }, "FileSystemAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync IAM role for file system access.
" + "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync\n IAM role for file system access.
" } }, "InTransitEncryption": { @@ -705,7 +564,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for an Amazon FSx for Lustre file system.\n DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you understand how DataSync\n accesses FSx for Lustre file systems.
" + "smithy.api#documentation": "Creates a transfer location for an Amazon FSx for Lustre file\n system. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses FSx for Lustre file systems.
" } }, "com.amazonaws.datasync#CreateLocationFsxLustreRequest": { @@ -714,27 +573,27 @@ "FsxFilesystemArn": { "target": "com.amazonaws.datasync#FsxFilesystemArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file\n system.
", "smithy.api#required": {} } }, "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide access to your\n FSx for Lustre file system.
\nThe security groups must be able to access the file system's ports. The file system must\n also allow access from the security groups. For information about file system access, see the\n \n Amazon FSx for Lustre User Guide\n .
", + "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide\n access to your FSx for Lustre file system.
\nThe security groups must be able to access the file system's ports. The file system must\n also allow access from the security groups. For information about file system access, see the\n \n Amazon FSx for Lustre User Guide\n .
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#FsxLustreSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).
Specifies a mount path for your FSx for Lustre file system. The path can include\n subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path.\n When the location is used as a destination, DataSync writes data to the mount path.\n If you don't include this parameter, DataSync uses the file system's root directory\n (/).
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services\n resources. We recommend creating at least a name tag for your location.
" } } }, @@ -802,7 +661,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#FsxOntapSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a path to the file share in the SVM where you want to transfer data to or from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nSpecifies a path to the file share in the SVM where you want to transfer data to or\n from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nCreates a transfer location for an Amazon FSx for OpenZFS file system.\n DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you understand how DataSync\n accesses FSx for OpenZFS file systems.
\nRequest parameters related to SMB aren't supported with the\n CreateLocationFsxOpenZfs operation.
Creates a transfer location for an Amazon FSx for OpenZFS file\n system. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses\n FSx for OpenZFS file systems.
\nRequest parameters related to SMB aren't supported with the\n CreateLocationFsxOpenZfs operation.
Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.
\nThe security groups that you specify must be able to communicate with your file system's\n security groups. For information about configuring security groups for file system access, see\n the \n Amazon FSx for Windows File Server User Guide\n .
\nIf you choose a security group that doesn't allow connections from within itself, do one\n of the following:
\nConfigure the security group to allow it to communicate within itself.
\nChoose a different security group that can communicate with the mount target's\n security group.
\nSpecifies the ARNs of the Amazon EC2 security groups that provide access to your\n file system's preferred subnet.
\nThe security groups that you specify must be able to communicate with your file system's\n security groups. For information about configuring security groups for file system access, see\n the \n Amazon FSx for Windows File Server User Guide\n .
\nIf you choose a security group that doesn't allow connections from within itself, do one\n of the following:
\nConfigure the security group to allow it to communicate within itself.
\nChoose a different security group that can communicate with the mount target's\n security group.
\nSpecifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.
\nFor information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
", + "smithy.api#documentation": "Specifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.
\nFor information about choosing a user with the right level of access for your transfer,\n see required permissions for FSx for Windows File Server locations.
", "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that the FSx for Windows File Server file system\n belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.
" } }, "Password": { @@ -1010,7 +869,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for a Hadoop Distributed File System\n (HDFS). DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses\n HDFS clusters.
" + "smithy.api#documentation": "Creates a transfer location for a Hadoop Distributed File System\n (HDFS). DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses HDFS\n clusters.
" } }, "com.amazonaws.datasync#CreateLocationHdfsRequest": { @@ -1075,7 +934,7 @@ "KerberosKeytab": { "target": "com.amazonaws.datasync#KerberosKeytabFile", "traits": { - "smithy.api#documentation": "The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address. If you're using the CLI, it performs base64 encoding for you.\n Otherwise, provide the base64-encoded text.
\nIf KERBEROS is specified for AuthenticationType, this\n parameter is required.
The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address.
\nIf KERBEROS is specified for AuthenticationType, this\n parameter is required.
The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your\n HDFS cluster.
", "smithy.api#required": {} } }, @@ -1133,7 +992,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for a Network File System (NFS) file\n server. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses\n NFS file servers.
" + "smithy.api#documentation": "Creates a transfer location for a Network File System (NFS) file\n server. DataSync can use this location as a source or destination for\n transferring data.
\nBefore you begin, make sure that you understand how DataSync\n accesses NFS file\n servers.
" } }, "com.amazonaws.datasync#CreateLocationNfsRequest": { @@ -1149,14 +1008,14 @@ "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "Specifies the DNS name or IP version 4 address of the NFS file\n server that your DataSync agent connects to.
", + "smithy.api#documentation": "Specifies the DNS name or IP version 4 address of the NFS file server that your DataSync agent connects to.
", "smithy.api#required": {} } }, "OnPremConfig": { "target": "com.amazonaws.datasync#OnPremConfig", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can\n connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync\n agents.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can\n connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync agents.
", "smithy.api#required": {} } }, @@ -1169,7 +1028,7 @@ "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.\n We recommend creating at least a name tag for your location.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
" } } }, @@ -1210,7 +1069,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you understand the prerequisites\n for DataSync to work with object storage systems.
" + "smithy.api#documentation": "Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
" } }, "com.amazonaws.datasync#CreateLocationObjectStorageRequest": { @@ -1219,7 +1078,7 @@ "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync\n agent connects to.
", + "smithy.api#documentation": "Specifies the domain name or IP version 4 (IPv4) address of the object storage server that\n your DataSync agent connects to.
", "smithy.api#required": {} } }, @@ -1317,7 +1176,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you read the following topics:
\n\n Storage\n class considerations with Amazon S3 locations\n
\nFor more information, see Configuring transfers with Amazon S3.
" + "smithy.api#documentation": "Creates a transfer location for an Amazon S3 bucket.\n DataSync can use this location as a source or destination for transferring\n data.
\nBefore you begin, make sure that you read the following topics:
\n\n Storage\n class considerations with Amazon S3 locations\n
\nFor more information, see Configuring\n transfers with Amazon S3.
" } }, "com.amazonaws.datasync#CreateLocationS3Request": { @@ -1326,13 +1185,13 @@ "Subdirectory": { "target": "com.amazonaws.datasync#S3Subdirectory", "traits": { - "smithy.api#documentation": "Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).
\nDataSync can't transfer objects with a prefix that begins with a slash\n (/) or includes //, /./, or\n /../ patterns. For example:
\n /photos\n
\n photos//2006/January\n
\n photos/./2006/February\n
\n photos/../2006/March\n
Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).
\nDataSync can't transfer objects with a prefix that begins with a slash (/)\n or includes //, /./, or /../ patterns. For\n example:
\n /photos\n
\n photos//2006/January\n
\n photos/./2006/February\n
\n photos/../2006/March\n
Specifies the ARN of the S3 bucket that you want to use as a location. (When creating\n your DataSync task later, you specify whether this location is a transfer source or\n destination.)
\nIf your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access\n point. For more information, see Managing data access with Amazon S3 access points in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the ARN of the S3 bucket that you want to use as a location. (When creating\n your DataSync task later, you specify whether this location is a transfer source or\n destination.)
\nIf your S3 bucket is located on an Outposts resource, you must specify an\n Amazon S3 access point. For more information, see Managing data access\n with Amazon S3 access points in the Amazon S3 User\n Guide.
", "smithy.api#required": {} } }, @@ -1351,13 +1210,13 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.
\nFor more information, see Deploy your DataSync agent\n on Outposts.
" + "smithy.api#documentation": "(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the\n DataSync agent on your Outpost.
\nFor more information, see Deploy your DataSync agent on Outposts.
" } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.\n We recommend creating at least a name tag for your transfer location.
" + "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
" } } }, @@ -1476,7 +1335,7 @@ "KerberosKeytab": { "target": "com.amazonaws.datasync#KerberosKeytabFile", "traits": { - "smithy.api#documentation": "Specifies your Kerberos key table (keytab) file, which includes mappings between your\n Kerberos principal and encryption keys.
\nThe file must be base64 encoded. If you're using the CLI, the encoding is\n done for you.
\nTo avoid task execution errors, make sure that the Kerberos principal that you use to\n create the keytab file matches exactly what you specify for KerberosPrincipal.
Specifies your Kerberos key table (keytab) file, which includes mappings between your\n Kerberos principal and encryption keys.
\nTo avoid task execution errors, make sure that the Kerberos principal that you use to\n create the keytab file matches exactly what you specify for KerberosPrincipal.\n
Configures a task, which defines where and how DataSync transfers your\n data.
\nA task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nConfigures a task, which defines where and how DataSync\n transfers your data.
\nA task includes a source location, destination location, and transfer options (such as\n bandwidth limits, scheduling, and more).
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nSpecifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
\nFor Enhanced mode tasks, you don't need to specify anything. DataSync\n automatically sends logs to a CloudWatch log group named /aws/datasync.
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
\nFor Enhanced mode tasks, you don't need to specify anything. DataSync\n automatically sends logs to a CloudWatch log group named\n /aws/datasync.
Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source\n location that you don't want DataSync to transfer. For more information and\n examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { @@ -1600,7 +1459,7 @@ "TaskMode": { "target": "com.amazonaws.datasync#TaskMode", "traits": { - "smithy.api#documentation": "Specifies one of the following task modes for your data transfer:
\n\n ENHANCED - Transfer virtually unlimited numbers of objects with higher\n performance than Basic mode. Enhanced mode tasks optimize the data transfer process by\n listing, preparing, transferring, and verifying data in parallel. Enhanced mode is\n currently available for transfers between Amazon S3 locations.
To create an Enhanced mode task, the IAM role that you use to call\n the CreateTask operation must have the\n iam:CreateServiceLinkedRole permission.
\n BASIC (default) - Transfer files or objects between Amazon Web Services\n storage and all other supported DataSync locations. Basic mode tasks are subject\n to quotas on the number of files, objects, and directories in a dataset. Basic\n mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced\n mode for most workloads.
For more information, see Understanding task mode differences.
" + "smithy.api#documentation": "Specifies one of the following task modes for your data transfer:
\n\n ENHANCED - Transfer virtually unlimited numbers of objects with higher\n performance than Basic mode. Enhanced mode tasks optimize the data transfer process by\n listing, preparing, transferring, and verifying data in parallel. Enhanced mode is\n currently available for transfers between Amazon S3 locations.
To create an Enhanced mode task, the IAM role that you use to call\n the CreateTask operation must have the\n iam:CreateServiceLinkedRole permission.
\n BASIC (default) - Transfer files or objects between Amazon Web Services\n storage and all other supported DataSync locations. Basic mode tasks are subject\n to quotas on the number of files, objects, and directories in a dataset. Basic\n mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced\n mode for most workloads.
For more information, see Understanding\n task mode differences.
" } } }, @@ -1624,28 +1483,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#Credentials": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.datasync#PtolemyUsername", - "traits": { - "smithy.api#documentation": "Specifies the user name for your storage system's management interface.
", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.datasync#PtolemyPassword", - "traits": { - "smithy.api#documentation": "Specifies the password for your storage system's management interface.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The credentials that provide DataSync Discovery read access to your on-premises storage system's\n management interface.
\nDataSync Discovery stores these credentials in Secrets Manager. For more\n information, see Accessing your on-premises\n storage system.
" - } - }, "com.amazonaws.datasync#DeleteAgent": { "type": "operation", "input": { @@ -1792,7 +1629,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an DataSync agent, such as its name, service endpoint\n type, and status.
" + "smithy.api#documentation": "Returns information about an DataSync agent, such as its name, service\n endpoint type, and status.
" } }, "com.amazonaws.datasync#DescribeAgentRequest": { @@ -1868,88 +1705,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#DescribeDiscoveryJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#DescribeDiscoveryJobRequest" - }, - "output": { - "target": "com.amazonaws.datasync#DescribeDiscoveryJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a DataSync discovery job.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#DescribeDiscoveryJobRequest": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want information\n about.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#DescribeDiscoveryJobResponse": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "The ARN of the on-premises storage system you're running the discovery job on.
" - } - }, - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "The ARN of the discovery job.
" - } - }, - "CollectionDurationMinutes": { - "target": "com.amazonaws.datasync#CollectionDurationMinutes", - "traits": { - "smithy.api#documentation": "The number of minutes that the discovery job runs.
" - } - }, - "Status": { - "target": "com.amazonaws.datasync#DiscoveryJobStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of a discovery job. For more information, see Discovery job statuses.
" - } - }, - "JobStartTime": { - "target": "com.amazonaws.datasync#DiscoveryTime", - "traits": { - "smithy.api#documentation": "The time when the discovery job started.
" - } - }, - "JobEndTime": { - "target": "com.amazonaws.datasync#DiscoveryTime", - "traits": { - "smithy.api#documentation": "The time when the discovery job ended.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#DescribeLocationAzureBlob": { "type": "operation", "input": { @@ -1967,7 +1722,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
" + "smithy.api#documentation": "Provides details about how an DataSync transfer location for Microsoft Azure\n Blob Storage is configured.
" } }, "com.amazonaws.datasync#DescribeLocationAzureBlobRequest": { @@ -1976,7 +1731,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer\n location.
", "smithy.api#required": {} } } @@ -2003,7 +1758,7 @@ "AuthenticationType": { "target": "com.amazonaws.datasync#AzureBlobAuthenticationType", "traits": { - "smithy.api#documentation": "The authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
" + "smithy.api#documentation": "The authentication method DataSync uses to access your Azure Blob Storage.\n DataSync can access blob storage using a shared access signature (SAS).
" } }, "BlobType": { @@ -2015,13 +1770,13 @@ "AccessTier": { "target": "com.amazonaws.datasync#AzureAccessTier", "traits": { - "smithy.api#documentation": "The access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
" + "smithy.api#documentation": "The access tier that you want your objects or files transferred into. This only applies\n when using the location as a transfer destination. For more information, see Access tiers.
" } }, "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.
" + "smithy.api#documentation": "The ARNs of the DataSync agents that can connect with your Azure Blob Storage\n container.
" } }, "CreationTime": { @@ -2098,13 +1853,13 @@ "AccessPointArn": { "target": "com.amazonaws.datasync#EfsAccessPointArn", "traits": { - "smithy.api#documentation": "The ARN of the access point that DataSync uses to access the Amazon EFS\n file system.
\nFor more information, see Accessing restricted file systems.
" + "smithy.api#documentation": "The ARN of the access point that DataSync uses to access the Amazon EFS\n file system.
\nFor more information, see Accessing\n restricted file systems.
" } }, "FileSystemAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) role that allows DataSync to\n access your Amazon EFS file system.
\nFor more information, see Creating a DataSync IAM role for file system access.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) role that allows DataSync to\n access your Amazon EFS file system.
\nFor more information, see Creating a DataSync\n IAM role for file system access.
" } }, "InTransitEncryption": { @@ -2883,13 +2638,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#DescribeStorageSystem": { + "com.amazonaws.datasync#DescribeTask": { "type": "operation", "input": { - "target": "com.amazonaws.datasync#DescribeStorageSystemRequest" + "target": "com.amazonaws.datasync#DescribeTaskRequest" }, "output": { - "target": "com.amazonaws.datasync#DescribeStorageSystemResponse" + "target": "com.amazonaws.datasync#DescribeTaskResponse" }, "errors": [ { @@ -2900,34 +2655,16 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an on-premises storage system that you're using with\n DataSync Discovery.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#DescribeStorageSystemRequest": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're\n using with DataSync Discovery.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides information about a task, which defines where and how\n DataSync transfers your data.
" } }, - "com.amazonaws.datasync#DescribeStorageSystemResourceMetrics": { + "com.amazonaws.datasync#DescribeTaskExecution": { "type": "operation", "input": { - "target": "com.amazonaws.datasync#DescribeStorageSystemResourceMetricsRequest" + "target": "com.amazonaws.datasync#DescribeTaskExecutionRequest" }, "output": { - "target": "com.amazonaws.datasync#DescribeStorageSystemResourceMetricsResponse" + "target": "com.amazonaws.datasync#DescribeTaskExecutionResponse" }, "errors": [ { @@ -2938,363 +2675,79 @@ } ], "traits": { - "smithy.api#documentation": "Returns information, including performance data and capacity usage, which DataSync Discovery\n collects about a specific resource in your-premises storage system.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Metrics", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing data transfer or check the\n results of the transfer.
\nSome DescribeTaskExecution response elements are only relevant to a\n specific task mode. For information, see Understanding task mode differences and Understanding data\n transfer performance counters.
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information\n about your on-premises storage system.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the task execution that you want\n information about.
", "smithy.api#required": {} } - }, - "ResourceType": { - "target": "com.amazonaws.datasync#DiscoveryResourceType", + } + }, + "traits": { + "smithy.api#documentation": "DescribeTaskExecutionRequest
", + "smithy.api#input": {} + } + }, + "com.amazonaws.datasync#DescribeTaskExecutionResponse": { + "type": "structure", + "members": { + "TaskExecutionArn": { + "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "Specifies the kind of storage system resource that you want information about.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the task execution that you wanted information about.\n TaskExecutionArn is hierarchical and includes TaskArn for the task\n that was executed.
For example, a TaskExecution value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
Specifies the universally unique identifier (UUID) of the storage system resource that you\n want information about.
", - "smithy.api#required": {} + "smithy.api#documentation": "The status of the task execution.
" } }, - "StartTime": { - "target": "com.amazonaws.datasync#DiscoveryTime", + "Options": { + "target": "com.amazonaws.datasync#Options" + }, + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a time within the total duration that the discovery job ran. To see information\n gathered during a certain time frame, use this parameter with EndTime.
A list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" } }, - "EndTime": { - "target": "com.amazonaws.datasync#DiscoveryTime", + "Includes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "Specifies a time within the total duration that the discovery job ran. To see information\n gathered during a certain time frame, use this parameter with StartTime.
A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" } }, - "MaxResults": { - "target": "com.amazonaws.datasync#DiscoveryMaxResults", + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", "traits": { - "smithy.api#documentation": "Specifies how many results that you want in the response.
" + "smithy.api#documentation": "The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.
" } }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", + "StartTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "Specifies an opaque string that indicates the position to begin the next list of results\n in the response.
" + "smithy.api#documentation": "The time when the task execution started.
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#DescribeStorageSystemResourceMetricsResponse": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.datasync#Metrics", + }, + "EstimatedFilesToTransfer": { + "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "The details that your discovery job collected about your storage system resource.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The number of files, objects, and directories that DataSync expects to\n transfer over the network. This value is calculated while DataSync\n prepares the transfer.
\nHow this gets calculated depends primarily on your task\u2019s transfer\n mode configuration:
\nIf TranserMode is set to CHANGED - The calculation is based\n on comparing the content of the source and destination locations and determining the\n difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
\nAnything that's in both locations and modified at the destination after an initial\n transfer (unless OverwriteMode is set to NEVER).
\n (Basic task mode only) The number of items that\n DataSync expects to delete (if PreserveDeletedFiles is set to\n REMOVE).
If TranserMode is set to ALL - The calculation is based only\n on the items that DataSync finds at the source location.
The opaque string that indicates the position to begin the next list of results in the\n response.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#DescribeStorageSystemResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#DescribeStorageSystemResourcesRequest" - }, - "output": { - "target": "com.amazonaws.datasync#DescribeStorageSystemResourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information that DataSync Discovery collects about resources in your on-premises storage\n system.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.datasync#DescribeStorageSystemResourcesRequest": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from\n your on-premises storage system.
", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.datasync#DiscoveryResourceType", - "traits": { - "smithy.api#documentation": "Specifies what kind of storage system resources that you want information about.
", - "smithy.api#required": {} - } - }, - "ResourceIds": { - "target": "com.amazonaws.datasync#ResourceIds", - "traits": { - "smithy.api#documentation": "Specifies the universally unique identifiers (UUIDs) of the storage system resources that\n you want information about. You can't use this parameter in combination with the\n Filter parameter.
Filters the storage system resources that you want returned. For example, this might be\n volumes associated with a specific storage virtual machine (SVM).
" - } - }, - "MaxResults": { - "target": "com.amazonaws.datasync#DiscoveryMaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of storage system resources that you want to list in a\n response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", - "traits": { - "smithy.api#documentation": "Specifies an opaque string that indicates the position to begin the next list of results\n in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#DescribeStorageSystemResourcesResponse": { - "type": "structure", - "members": { - "ResourceDetails": { - "target": "com.amazonaws.datasync#ResourceDetails", - "traits": { - "smithy.api#documentation": "The information collected about your storage system's resources. A response can also\n include Amazon Web Services storage service recommendations.
\nFor more information, see storage resource\n information collected by and recommendations provided by DataSync Discovery.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", - "traits": { - "smithy.api#documentation": "The opaque string that indicates the position to begin the next list of results in the\n response.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#DescribeStorageSystemResponse": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "The ARN of the on-premises storage system that the discovery job looked at.
" - } - }, - "ServerConfiguration": { - "target": "com.amazonaws.datasync#DiscoveryServerConfiguration", - "traits": { - "smithy.api#documentation": "The server name and network port required to connect with your on-premises storage\n system's management interface.
" - } - }, - "SystemType": { - "target": "com.amazonaws.datasync#DiscoverySystemType", - "traits": { - "smithy.api#documentation": "The type of on-premises storage system.
\nDataSync Discovery currently only supports NetApp\n Fabric-Attached\n Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.\n
\nThe ARN of the DataSync agent that connects to and reads from your on-premises storage\n system.
" - } - }, - "Name": { - "target": "com.amazonaws.datasync#Name", - "traits": { - "smithy.api#documentation": "The name that you gave your on-premises storage system when adding it to DataSync Discovery.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.datasync#ErrorMessage", - "traits": { - "smithy.api#documentation": "Describes the connectivity error that the DataSync agent is encountering with your\n on-premises storage system.
" - } - }, - "ConnectivityStatus": { - "target": "com.amazonaws.datasync#StorageSystemConnectivityStatus", - "traits": { - "smithy.api#documentation": "Indicates whether your DataSync agent can connect to your on-premises storage system.
" - } - }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", - "traits": { - "smithy.api#documentation": "The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery\n job events.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.datasync#Timestamp", - "traits": { - "smithy.api#documentation": "The time when you added the on-premises storage system to DataSync Discovery.
" - } - }, - "SecretsManagerArn": { - "target": "com.amazonaws.datasync#SecretsManagerArn", - "traits": { - "smithy.api#documentation": "The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery\n stores these credentials in Secrets Manager.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#DescribeTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#DescribeTaskRequest" - }, - "output": { - "target": "com.amazonaws.datasync#DescribeTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Provides information about a task, which defines where and how DataSync transfers your data.
" - } - }, - "com.amazonaws.datasync#DescribeTaskExecution": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#DescribeTaskExecutionRequest" - }, - "output": { - "target": "com.amazonaws.datasync#DescribeTaskExecutionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing data transfer or check the\n results of the transfer.
\nSome DescribeTaskExecution response elements are only relevant to a\n specific task mode. For information, see Understanding task mode differences and Understanding data\n transfer performance counters.
Specifies the Amazon Resource Name (ARN) of the task execution that you want\n information about.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "DescribeTaskExecutionRequest
", - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#DescribeTaskExecutionResponse": { - "type": "structure", - "members": { - "TaskExecutionArn": { - "target": "com.amazonaws.datasync#TaskExecutionArn", - "traits": { - "smithy.api#documentation": "The ARN of the task execution that you wanted information about.\n TaskExecutionArn is hierarchical and includes TaskArn for the task\n that was executed.
For example, a TaskExecution value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
The status of the task execution.
" - } - }, - "Options": { - "target": "com.amazonaws.datasync#Options" - }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", - "traits": { - "smithy.api#documentation": "A list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" - } - }, - "Includes": { - "target": "com.amazonaws.datasync#FilterList", - "traits": { - "smithy.api#documentation": "A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.
" - } - }, - "ManifestConfig": { - "target": "com.amazonaws.datasync#ManifestConfig", - "traits": { - "smithy.api#documentation": "The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.
" - } - }, - "StartTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "The time when the task execution started.
" - } - }, - "EstimatedFilesToTransfer": { - "target": "com.amazonaws.datasync#long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of files, objects, and directories that DataSync expects to\n transfer over the network. This value is calculated while DataSync prepares the transfer.
\nHow this gets calculated depends primarily on your task\u2019s transfer\n mode configuration:
\nIf TranserMode is set to CHANGED - The calculation is based\n on comparing the content of the source and destination locations and determining the\n difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
\nAnything that's in both locations and modified at the destination after an initial\n transfer (unless OverwriteMode is set to NEVER).
\n (Basic task mode only) The number of items that\n DataSync expects to delete (if PreserveDeletedFiles is set to\n REMOVE).
If TranserMode is set to ALL - The calculation is based only\n on the items that DataSync finds at the source location.
The number of logical bytes that DataSync expects to write to the destination\n location.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The number of logical bytes that DataSync expects to write to the destination\n location.
" } }, "FilesTransferred": { @@ -3374,7 +2827,7 @@ "TaskMode": { "target": "com.amazonaws.datasync#TaskMode", "traits": { - "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data\n transfer.
" } }, "FilesPrepared": { @@ -3484,13 +2937,13 @@ "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" + "smithy.api#documentation": "The exclude filters that define the files, objects, and folders in your source location\n that you don't want DataSync to transfer. For more information and examples, see\n Specifying what\n DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "The schedule for when you want your task to run. For more information, see Scheduling your\n task.
" + "smithy.api#documentation": "The schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "ErrorCode": { @@ -3526,234 +2979,32 @@ "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "The configuration of your task report, which provides detailed information about your\n DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
" - } - }, - "ScheduleDetails": { - "target": "com.amazonaws.datasync#TaskScheduleDetails", - "traits": { - "smithy.api#documentation": "The details about your task schedule.
" - } - }, - "TaskMode": { - "target": "com.amazonaws.datasync#TaskMode", - "traits": { - "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" - } - } - }, - "traits": { - "smithy.api#documentation": "DescribeTaskResponse
", - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#DestinationNetworkInterfaceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#NetworkInterfaceArn" - } - }, - "com.amazonaws.datasync#DiscoveryAgentArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#AgentArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.datasync#DiscoveryJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.datasync#DiscoveryJobList": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#DiscoveryJobListEntry" - } - }, - "com.amazonaws.datasync#DiscoveryJobListEntry": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a discovery job.
" - } - }, - "Status": { - "target": "com.amazonaws.datasync#DiscoveryJobStatus", - "traits": { - "smithy.api#documentation": "The status of a discovery job. For more information, see Discovery job statuses.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details about a specific DataSync discovery job.
" - } - }, - "com.amazonaws.datasync#DiscoveryJobStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "WARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WARNING" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "COMPLETED_WITH_ISSUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED_WITH_ISSUES" - } - } - } - }, - "com.amazonaws.datasync#DiscoveryMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.datasync#DiscoveryNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 65535 - }, - "smithy.api#pattern": "^[a-zA-Z0-9=_-]+$" - } - }, - "com.amazonaws.datasync#DiscoveryResourceFilter": { - "type": "enum", - "members": { - "SVM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SVM" - } - } - } - }, - "com.amazonaws.datasync#DiscoveryResourceType": { - "type": "enum", - "members": { - "SVM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SVM" - } - }, - "VOLUME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VOLUME" - } - }, - "CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER" - } - } - } - }, - "com.amazonaws.datasync#DiscoveryServerConfiguration": { - "type": "structure", - "members": { - "ServerHostname": { - "target": "com.amazonaws.datasync#DiscoveryServerHostname", - "traits": { - "smithy.api#documentation": "The domain name or IP address of your storage system's management interface.
", - "smithy.api#required": {} - } - }, - "ServerPort": { - "target": "com.amazonaws.datasync#DiscoveryServerPort", - "traits": { - "smithy.api#documentation": "The network port for accessing the storage system's management interface.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The network settings that DataSync Discovery uses to connect with your on-premises storage system's\n management interface.
" - } - }, - "com.amazonaws.datasync#DiscoveryServerHostname": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" - } - }, - "com.amazonaws.datasync#DiscoveryServerPort": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.datasync#DiscoverySystemType": { - "type": "enum", - "members": { - "NetAppONTAP": { - "target": "smithy.api#Unit", + "smithy.api#documentation": "The configuration of your task report, which provides detailed information about your\n DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
" + } + }, + "ScheduleDetails": { + "target": "com.amazonaws.datasync#TaskScheduleDetails", + "traits": { + "smithy.api#documentation": "The details about your task schedule.
" + } + }, + "TaskMode": { + "target": "com.amazonaws.datasync#TaskMode", "traits": { - "smithy.api#enumValue": "NetAppONTAP" + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data\n transfer.
" } } + }, + "traits": { + "smithy.api#documentation": "DescribeTaskResponse
", + "smithy.api#output": {} } }, - "com.amazonaws.datasync#DiscoveryTime": { - "type": "timestamp" + "com.amazonaws.datasync#DestinationNetworkInterfaceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.datasync#NetworkInterfaceArn" + } }, "com.amazonaws.datasync#DnsIpList": { "type": "list", @@ -3876,12 +3127,6 @@ "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$" } }, - "com.amazonaws.datasync#EnabledProtocols": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#PtolemyString" - } - }, "com.amazonaws.datasync#Endpoint": { "type": "string", "traits": { @@ -3915,16 +3160,6 @@ } } }, - "com.amazonaws.datasync#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": ".*" - } - }, "com.amazonaws.datasync#FilterAttributeValue": { "type": "string", "traits": { @@ -3947,12 +3182,6 @@ } } }, - "com.amazonaws.datasync#FilterMembers": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#PtolemyString" - } - }, "com.amazonaws.datasync#FilterRule": { "type": "structure", "members": { @@ -4011,9 +3240,6 @@ "type": "service", "version": "2018-11-09", "operations": [ - { - "target": "com.amazonaws.datasync#AddStorageSystem" - }, { "target": "com.amazonaws.datasync#CancelTaskExecution" }, @@ -4068,9 +3294,6 @@ { "target": "com.amazonaws.datasync#DescribeAgent" }, - { - "target": "com.amazonaws.datasync#DescribeDiscoveryJob" - }, { "target": "com.amazonaws.datasync#DescribeLocationAzureBlob" }, @@ -4104,36 +3327,18 @@ { "target": "com.amazonaws.datasync#DescribeLocationSmb" }, - { - "target": "com.amazonaws.datasync#DescribeStorageSystem" - }, - { - "target": "com.amazonaws.datasync#DescribeStorageSystemResourceMetrics" - }, - { - "target": "com.amazonaws.datasync#DescribeStorageSystemResources" - }, { "target": "com.amazonaws.datasync#DescribeTask" }, { "target": "com.amazonaws.datasync#DescribeTaskExecution" }, - { - "target": "com.amazonaws.datasync#GenerateRecommendations" - }, { "target": "com.amazonaws.datasync#ListAgents" }, - { - "target": "com.amazonaws.datasync#ListDiscoveryJobs" - }, { "target": "com.amazonaws.datasync#ListLocations" }, - { - "target": "com.amazonaws.datasync#ListStorageSystems" - }, { "target": "com.amazonaws.datasync#ListTagsForResource" }, @@ -4143,18 +3348,9 @@ { "target": "com.amazonaws.datasync#ListTasks" }, - { - "target": "com.amazonaws.datasync#RemoveStorageSystem" - }, - { - "target": "com.amazonaws.datasync#StartDiscoveryJob" - }, { "target": "com.amazonaws.datasync#StartTaskExecution" }, - { - "target": "com.amazonaws.datasync#StopDiscoveryJob" - }, { "target": "com.amazonaws.datasync#TagResource" }, @@ -4164,9 +3360,6 @@ { "target": "com.amazonaws.datasync#UpdateAgent" }, - { - "target": "com.amazonaws.datasync#UpdateDiscoveryJob" - }, { "target": "com.amazonaws.datasync#UpdateLocationAzureBlob" }, @@ -4200,9 +3393,6 @@ { "target": "com.amazonaws.datasync#UpdateLocationSmb" }, - { - "target": "com.amazonaws.datasync#UpdateStorageSystem" - }, { "target": "com.amazonaws.datasync#UpdateTask" }, @@ -4222,7 +3412,7 @@ "name": "datasync" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "DataSync is an online data movement and discovery service that simplifies data migration\n and helps you quickly, easily, and securely transfer your file or object data to, from, and\n between Amazon Web Services storage services.
\nThis API interface reference includes documentation for using DataSync\n programmatically. For complete information, see the \n DataSync User\n Guide\n .
", + "smithy.api#documentation": "DataSync is an online data movement and discovery service that simplifies\n data migration and helps you quickly, easily, and securely transfer your file or object data\n to, from, and between Amazon Web Services storage services.
\nThis API interface reference includes documentation for using DataSync\n programmatically. For complete information, see the \n DataSync User\n Guide\n .
", "smithy.api#title": "AWS DataSync", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5282,7 +4472,7 @@ "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
\nIf you have multiple domains in your environment, configuring this setting makes sure that\n DataSync connects to the right SVM.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs\n to.
\nIf you have multiple domains in your environment, configuring this setting makes sure that\n DataSync connects to the right SVM.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right SVM.
" } }, "MountOptions": { @@ -5298,13 +4488,13 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "Specifies a user that can mount and access the files, folders, and metadata in your SVM.
\nFor information about choosing a user with the right level of access for your transfer, see Using\n the SMB protocol.
", + "smithy.api#documentation": "Specifies a user that can mount and access the files, folders, and metadata in your\n SVM.
\nFor information about choosing a user with the right level of access for your transfer,\n see Using\n the SMB protocol.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see\n Providing DataSync access to FSx for ONTAP file systems.
" + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine\n (SVM). For more information, see Providing DataSync access to FSx for ONTAP file systems.
" } }, "com.amazonaws.datasync#FsxUpdateProtocol": { @@ -5316,12 +4506,12 @@ "SMB": { "target": "com.amazonaws.datasync#FsxUpdateProtocolSmb", "traits": { - "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync\n uses to access your FSx for ONTAP file system's storage virtual machine (SVM).
" + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync\n uses to access your FSx for ONTAP file system's storage virtual machine\n (SVM).
" } } }, "traits": { - "smithy.api#documentation": "Specifies the data transfer protocol that DataSync uses to access your\n Amazon FSx file system.
\nYou can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with this location type.
\nSpecifies the data transfer protocol that DataSync uses to access your\n Amazon FSx file system.
\nYou can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with\n this location type.
\nSpecifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs\n to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right SVM.
" } }, "MountOptions": { @@ -5345,12 +4535,12 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "Specifies a user that can mount and access the files, folders, and metadata in your SVM.
\nFor information about choosing a user with the right level of access for your transfer, see Using\n the SMB protocol.
" + "smithy.api#documentation": "Specifies a user that can mount and access the files, folders, and metadata in your\n SVM.
\nFor information about choosing a user with the right level of access for your transfer,\n see Using\n the SMB protocol.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see\n Providing DataSync access to FSx for ONTAP file systems.
" + "smithy.api#documentation": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine\n (SVM). For more information, see Providing DataSync access to FSx for ONTAP file systems.
" } }, "com.amazonaws.datasync#FsxWindowsSubdirectory": { @@ -5363,65 +4553,6 @@ "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" } }, - "com.amazonaws.datasync#GenerateRecommendations": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#GenerateRecommendationsRequest" - }, - "output": { - "target": "com.amazonaws.datasync#GenerateRecommendationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Creates recommendations about where to migrate your data to in Amazon Web Services.\n Recommendations are generated based on information that DataSync Discovery collects about your\n on-premises storage system's resources. For more information, see Recommendations\n provided by DataSync Discovery.
\nOnce generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#GenerateRecommendationsRequest": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the discovery job that collects information\n about your on-premises storage system.
", - "smithy.api#required": {} - } - }, - "ResourceIds": { - "target": "com.amazonaws.datasync#ResourceIds", - "traits": { - "smithy.api#documentation": "Specifies the universally unique identifiers (UUIDs) of the resources in your storage\n system that you want recommendations on.
", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.datasync#DiscoveryResourceType", - "traits": { - "smithy.api#documentation": "Specifies the type of resource in your storage system that you want recommendations\n on.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#GenerateRecommendationsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#Gid": { "type": "enum", "members": { @@ -5616,38 +4747,6 @@ "smithy.api#pattern": "^[_.A-Za-z0-9][-_.A-Za-z0-9]*$" } }, - "com.amazonaws.datasync#IOPS": { - "type": "structure", - "members": { - "Read": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS related to read operations.
" - } - }, - "Write": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS related to write operations.
" - } - }, - "Other": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS unrelated to read and write operations.
" - } - }, - "Total": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak total IOPS on your on-premises storage system resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The IOPS peaks for an on-premises storage system\n resource.\n Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, "com.amazonaws.datasync#IamRoleArn": { "type": "string", "traits": { @@ -5741,32 +4840,6 @@ "smithy.api#pattern": "^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$" } }, - "com.amazonaws.datasync#Latency": { - "type": "structure", - "members": { - "Read": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for read operations.
" - } - }, - "Write": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for write operations.
" - } - }, - "Other": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for operations unrelated to read and write operations.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The latency peaks for an on-premises storage system\n resource.\n Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, "com.amazonaws.datasync#ListAgents": { "type": "operation", "input": { @@ -5835,81 +4908,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#ListDiscoveryJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#ListDiscoveryJobsRequest" - }, - "output": { - "target": "com.amazonaws.datasync#ListDiscoveryJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Provides a list of the existing discovery jobs in the Amazon Web Services Region and\n Amazon Web Services account where you're using DataSync Discovery.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DiscoveryJobs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.datasync#ListDiscoveryJobsRequest": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this\n parameter if you only want to list the discovery jobs that are associated with a specific\n storage system.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.datasync#DiscoveryMaxResults", - "traits": { - "smithy.api#documentation": "Specifies how many results you want in the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", - "traits": { - "smithy.api#documentation": "Specifies an opaque string that indicates the position to begin the next list of results\n in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#ListDiscoveryJobsResponse": { - "type": "structure", - "members": { - "DiscoveryJobs": { - "target": "com.amazonaws.datasync#DiscoveryJobList", - "traits": { - "smithy.api#documentation": "The discovery jobs that you've run.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", - "traits": { - "smithy.api#documentation": "The opaque string that indicates the position to begin the next list of results in the\n response.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#ListLocations": { "type": "operation", "input": { @@ -5951,105 +4949,36 @@ "smithy.api#documentation": "An opaque string that indicates the position at which to begin the next list of\n locations.
" } }, - "Filters": { - "target": "com.amazonaws.datasync#LocationFilters", - "traits": { - "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by\n ListLocations. For example, to retrieve all tasks on a specific source\n location, you can use ListLocations with filter name LocationType S3\n and Operator Equals.
ListLocationsRequest
", - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#ListLocationsResponse": { - "type": "structure", - "members": { - "Locations": { - "target": "com.amazonaws.datasync#LocationList", - "traits": { - "smithy.api#documentation": "An array that contains a list of locations.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#NextToken", - "traits": { - "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of locations.
" - } - } - }, - "traits": { - "smithy.api#documentation": "ListLocationsResponse
", - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#ListStorageSystems": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#ListStorageSystemsRequest" - }, - "output": { - "target": "com.amazonaws.datasync#ListStorageSystemsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the on-premises storage systems that you're using with DataSync Discovery.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StorageSystems", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.datasync#ListStorageSystemsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.datasync#DiscoveryMaxResults", - "traits": { - "smithy.api#documentation": "Specifies how many results you want in the response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", + "Filters": { + "target": "com.amazonaws.datasync#LocationFilters", "traits": { - "smithy.api#documentation": "Specifies an opaque string that indicates the position to begin the next list of results\n in the response.
" + "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by\n ListLocations. For example, to retrieve all tasks on a specific source\n location, you can use ListLocations with filter name LocationType S3\n and Operator Equals.
ListLocationsRequest
", "smithy.api#input": {} } }, - "com.amazonaws.datasync#ListStorageSystemsResponse": { + "com.amazonaws.datasync#ListLocationsResponse": { "type": "structure", "members": { - "StorageSystems": { - "target": "com.amazonaws.datasync#StorageSystemList", + "Locations": { + "target": "com.amazonaws.datasync#LocationList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with\n DataSync Discovery.
" + "smithy.api#documentation": "An array that contains a list of locations.
" } }, "NextToken": { - "target": "com.amazonaws.datasync#DiscoveryNextToken", + "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "The opaque string that indicates the position to begin the next list of results in the\n response.
" + "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of locations.
" } } }, "traits": { + "smithy.api#documentation": "ListLocationsResponse
", "smithy.api#output": {} } }, @@ -6419,451 +5348,72 @@ "TRANSFER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TRANSFER" - } - } - } - }, - "com.amazonaws.datasync#ManifestConfig": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.datasync#ManifestAction", - "traits": { - "smithy.api#documentation": "Specifies what DataSync uses the manifest for.
" - } - }, - "Format": { - "target": "com.amazonaws.datasync#ManifestFormat", - "traits": { - "smithy.api#documentation": "Specifies the file format of your manifest. For more information, see Creating a manifest.
" - } - }, - "Source": { - "target": "com.amazonaws.datasync#SourceManifestConfig", - "traits": { - "smithy.api#documentation": "Specifies the manifest that you want DataSync to use and where it's\n hosted.
\nYou must specify this parameter if you're configuring a new manifest on or after February 7,\n 2024.
\nIf you don't, you'll get a 400 status code and ValidationException error\n stating that you're missing the IAM role for DataSync to access the\n S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.
Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
" - } - }, - "com.amazonaws.datasync#ManifestFormat": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - } - } - }, - "com.amazonaws.datasync#MaxP95Performance": { - "type": "structure", - "members": { - "IopsRead": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS related to read operations.
" - } - }, - "IopsWrite": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS related to write operations.
" - } - }, - "IopsOther": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak IOPS unrelated to read and write operations.
" - } - }, - "IopsTotal": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak total IOPS on your on-premises storage system resource.
" - } - }, - "ThroughputRead": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput related to read operations.
" - } - }, - "ThroughputWrite": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput related to write operations.
" - } - }, - "ThroughputOther": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput unrelated to read and write operations.
" - } - }, - "ThroughputTotal": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak total throughput on your on-premises storage system resource.
" - } - }, - "LatencyRead": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for read operations.
" - } - }, - "LatencyWrite": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for write operations.
" - } - }, - "LatencyOther": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak latency for operations unrelated to read and write operations.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The performance data that DataSync Discovery collects about an on-premises storage system\n resource.
" - } - }, - "com.amazonaws.datasync#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.datasync#Metrics": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#ResourceMetrics" - } - }, - "com.amazonaws.datasync#Mtime": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "PRESERVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRESERVE" - } - } - } - }, - "com.amazonaws.datasync#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{N}\\s+=._:@\\/-]+$" - } - }, - "com.amazonaws.datasync#NetAppONTAPCluster": { - "type": "structure", - "members": { - "CifsShareCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of CIFS shares in the cluster.
" - } - }, - "NfsExportedVolumes": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of NFS volumes in the cluster.
" - } - }, - "ResourceId": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "The universally unique identifier (UUID) of the cluster.
" - } - }, - "ClusterName": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The name of the cluster.
" - } - }, - "MaxP95Performance": { - "target": "com.amazonaws.datasync#MaxP95Performance", - "traits": { - "smithy.api#documentation": "The performance data that DataSync Discovery collects about the cluster.
" - } - }, - "ClusterBlockStorageSize": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The total storage space that's available in the cluster.
" - } - }, - "ClusterBlockStorageUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in a cluster.
" - } - }, - "ClusterBlockStorageLogicalUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in the cluster without accounting for compression or\n deduplication.
" - } - }, - "Recommendations": { - "target": "com.amazonaws.datasync#Recommendations", - "traits": { - "smithy.api#documentation": "The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For\n more information, see Recommendations\n provided by DataSync Discovery.
" - } - }, - "RecommendationStatus": { - "target": "com.amazonaws.datasync#RecommendationStatus", - "traits": { - "smithy.api#documentation": "Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete,\n or can't be determined.
\nFor more information, see Recommendation statuses.
" - } - }, - "LunCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of LUNs (logical unit numbers) in the cluster.
" - } - }, - "ClusterCloudStorageUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" - } - } - }, - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about an on-premises storage system\n cluster.
" - } - }, - "com.amazonaws.datasync#NetAppONTAPClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#NetAppONTAPCluster" - } - }, - "com.amazonaws.datasync#NetAppONTAPSVM": { - "type": "structure", - "members": { - "ClusterUuid": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "The universally unique identifier (UUID) of the cluster associated with the SVM.
" - } - }, - "ResourceId": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "The UUID of the SVM.
" - } - }, - "SvmName": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The name of the SVM
" - } - }, - "CifsShareCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of CIFS shares in the SVM.
" - } - }, - "EnabledProtocols": { - "target": "com.amazonaws.datasync#EnabledProtocols", - "traits": { - "smithy.api#documentation": "The data transfer protocols (such as NFS) configured for the SVM.
" - } - }, - "TotalCapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in the SVM.
" - } - }, - "TotalCapacityProvisioned": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The total storage space that's available in the SVM.
" - } - }, - "TotalLogicalCapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in the SVM without accounting for compression or\n deduplication.
" - } - }, - "MaxP95Performance": { - "target": "com.amazonaws.datasync#MaxP95Performance", - "traits": { - "smithy.api#documentation": "The performance data that DataSync Discovery collects about the SVM.
" - } - }, - "Recommendations": { - "target": "com.amazonaws.datasync#Recommendations", - "traits": { - "smithy.api#documentation": "The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more\n information, see Recommendations\n provided by DataSync Discovery.
" - } - }, - "NfsExportedVolumes": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of NFS volumes in the SVM.
" - } - }, - "RecommendationStatus": { - "target": "com.amazonaws.datasync#RecommendationStatus", - "traits": { - "smithy.api#documentation": "Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or\n can't be determined.
\nFor more information, see Recommendation statuses.
" - } - }, - "TotalSnapshotCapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The amount of storage in the SVM that's being used for snapshots.
" - } - }, - "LunCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of LUNs (logical unit numbers) in the SVM.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about a storage virtual machine (SVM) in your\n on-premises storage system.
" - } - }, - "com.amazonaws.datasync#NetAppONTAPSVMs": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#NetAppONTAPSVM" - } - }, - "com.amazonaws.datasync#NetAppONTAPVolume": { - "type": "structure", - "members": { - "VolumeName": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The name of the volume.
" - } - }, - "ResourceId": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "The universally unique identifier (UUID) of the volume.
" - } - }, - "CifsShareCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The number of CIFS shares in the volume.
" - } - }, - "SecurityStyle": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The volume's security style (such as Unix or NTFS).
" - } - }, - "SvmUuid": { - "target": "com.amazonaws.datasync#PtolemyUUID", - "traits": { - "smithy.api#documentation": "The UUID of the storage virtual machine (SVM) associated with the volume.
" - } - }, - "SvmName": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The name of the SVM associated with the volume.
" - } - }, - "CapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in the volume.
" - } - }, - "CapacityProvisioned": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The total storage space that's available in the volume.
" - } - }, - "LogicalCapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", - "traits": { - "smithy.api#documentation": "The storage space that's being used in the volume without accounting for compression or\n deduplication.
" + "smithy.api#enumValue": "TRANSFER" } - }, - "NfsExported": { - "target": "com.amazonaws.datasync#PtolemyBoolean", + } + } + }, + "com.amazonaws.datasync#ManifestConfig": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.datasync#ManifestAction", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The number of NFS volumes in the volume.
" + "smithy.api#documentation": "Specifies what DataSync uses the manifest for.
" } }, - "SnapshotCapacityUsed": { - "target": "com.amazonaws.datasync#NonNegativeLong", + "Format": { + "target": "com.amazonaws.datasync#ManifestFormat", "traits": { - "smithy.api#documentation": "The amount of storage in the volume that's being used for snapshots.
" + "smithy.api#documentation": "Specifies the file format of your manifest. For more information, see Creating a manifest.
" } }, - "MaxP95Performance": { - "target": "com.amazonaws.datasync#MaxP95Performance", + "Source": { + "target": "com.amazonaws.datasync#SourceManifestConfig", "traits": { - "smithy.api#documentation": "The performance data that DataSync Discovery collects about the volume.
" + "smithy.api#documentation": "Specifies the manifest that you want DataSync to use and where it's\n hosted.
\nYou must specify this parameter if you're configuring a new manifest on or after\n February 7, 2024.
\nIf you don't, you'll get a 400 status code and ValidationException error\n stating that you're missing the IAM role for DataSync to access the\n S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.
Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
" + } + }, + "com.amazonaws.datasync#ManifestFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more\n information, see Recommendations\n provided by DataSync Discovery.
" + "smithy.api#enumValue": "CSV" } - }, - "RecommendationStatus": { - "target": "com.amazonaws.datasync#RecommendationStatus", + } + } + }, + "com.amazonaws.datasync#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.datasync#Mtime": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete,\n or can't be determined.
\nFor more information, see Recommendation statuses.
" + "smithy.api#enumValue": "NONE" } }, - "LunCount": { - "target": "com.amazonaws.datasync#NonNegativeLong", + "PRESERVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of LUNs (logical unit numbers) in the volume.
" + "smithy.api#enumValue": "PRESERVE" } } - }, - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about a volume in your on-premises storage\n system.
" - } - }, - "com.amazonaws.datasync#NetAppONTAPVolumes": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#NetAppONTAPVolume" } }, "com.amazonaws.datasync#NetworkInterfaceArn": { @@ -6939,22 +5489,6 @@ } } }, - "com.amazonaws.datasync#NonNegativeDouble": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.datasync#NonNegativeLong": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, "com.amazonaws.datasync#ObjectStorageAccessKey": { "type": "string", "traits": { @@ -7061,7 +5595,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync\n agents.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to\n your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync agents.
", "smithy.api#required": {} } } @@ -7141,7 +5675,7 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "Specifies if and how DataSync checks the integrity of your data at the end of\n your transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred data (including metadata) at the source location. At the end\n of the transfer, DataSync then compares this checksum to the checksum calculated\n on that data at the destination.
This is the default option for Enhanced mode\n tasks.
\nWe recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are\n fully synchronized.
The is the default option for Basic mode tasks and\n isn't currently supported with Enhanced mode tasks.
\nIf you use a manifest, DataSync only scans and\n verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync performs data integrity checks only during\n your transfer. Unlike other options, there's no additional verification at the end of your\n transfer.
Specifies if and how DataSync checks the integrity of your data at the end of\n your transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred data (including metadata) at the source location. At the end\n of the transfer, DataSync then compares this checksum to the checksum calculated\n on that data at the destination.
This is the default option for Enhanced mode\n tasks.
\nWe recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are\n fully synchronized.
The is the default option for Basic mode tasks and\n isn't currently supported with Enhanced mode tasks.
\nIf you use a manifest,\n DataSync only scans and verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync performs data integrity checks only during\n your transfer. Unlike other options, there's no additional verification at the end of your\n transfer.
Specifies the POSIX group ID (GID) of the file's owners.
\n\n INT_VALUE (default) - Preserves the integer value of user ID (UID) and\n GID, which is recommended.
\n NONE - Ignores UID and GID.
For more information, see Understanding how DataSync handles file and object metadata.
" + "smithy.api#documentation": "Specifies the POSIX group ID (GID) of the file's owners.
\n\n INT_VALUE (default) - Preserves the integer value of user ID (UID) and\n GID, which is recommended.
\n NONE - Ignores UID and GID.
For more information, see Understanding how DataSync handles file and object\n metadata.
" } }, "PreserveDeletedFiles": { @@ -7189,7 +5723,7 @@ "PosixPermissions": { "target": "com.amazonaws.datasync#PosixPermissions", "traits": { - "smithy.api#documentation": "Specifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.
\nFor more information, see Understanding how DataSync handles file and object metadata.
\n\n PRESERVE (default) - Preserves POSIX-style permissions, which is\n recommended.
\n NONE - Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
\nSpecifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.
\nFor more information, see Understanding how DataSync handles file and object\n metadata.
\n\n PRESERVE (default) - Preserves POSIX-style permissions, which is\n recommended.
\n NONE - Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
\nSpecifies which components of the SMB security descriptor are copied from source to\n destination objects.
\nThis value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see Understanding how DataSync handles file and object metadata.
\n\n OWNER_DACL (default) - For each copied object, DataSync copies\n the following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nDataSync won't copy NTFS system access control lists (SACLs) with this\n option.
\n\n OWNER_DACL_SACL - For each copied object, DataSync copies the\n following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nSACLs, which are used by administrators to log attempts to access a secured\n object.
\nCopying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing\n a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending\n on the type of location in your transfer).
\n\n NONE - None of the SMB security descriptor components are copied.\n Destination objects are owned by the user that was provided for accessing the destination\n location. DACLs and SACLs are set based on the destination server\u2019s configuration.
Specifies which components of the SMB security descriptor are copied from source to\n destination objects.
\nThis value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see Understanding how\n DataSync handles file and object metadata.
\n\n OWNER_DACL (default) - For each copied object, DataSync copies\n the following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nDataSync won't copy NTFS system access control lists (SACLs) with this\n option.
\n\n OWNER_DACL_SACL - For each copied object, DataSync copies the\n following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nSACLs, which are used by administrators to log attempts to access a secured\n object.
\nCopying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing\n a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of\n location in your transfer).
\n\n NONE - None of the SMB security descriptor components are copied.\n Destination objects are owned by the user that was provided for accessing the destination\n location. DACLs and SACLs are set based on the destination server\u2019s configuration.
Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.
\nYou also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.
Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.
\nEach option has a default value. Unless you need to, you don't have to configure any\n option before calling StartTaskExecution.
\nYou also can override your task options for each task execution. For example, you might\n want to adjust the LogLevel for an individual execution.
The IOPS peaks for an on-premises storage system resource. Each data point represents the\n 95th percentile peak value during a 1-hour interval.
" - } - }, - "Throughput": { - "target": "com.amazonaws.datasync#Throughput", - "traits": { - "smithy.api#documentation": "The throughput peaks for an on-premises storage system resource. Each data point\n represents the 95th percentile peak value during a 1-hour interval.
" - } - }, - "Latency": { - "target": "com.amazonaws.datasync#Latency", - "traits": { - "smithy.api#documentation": "The latency peaks for an on-premises storage system resource. Each data point represents\n the 95th percentile peak value during a 1-hour interval.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The types of performance data that DataSync Discovery collects about an on-premises storage system\n resource.
" - } - }, "com.amazonaws.datasync#PLSecurityGroupArnList": { "type": "list", "member": { @@ -7412,7 +5920,7 @@ "PrivateLinkEndpoint": { "target": "com.amazonaws.datasync#Endpoint", "traits": { - "smithy.api#documentation": "Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that\n your agent connects to.
" + "smithy.api#documentation": "Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.
" } }, "SubnetArns": { @@ -7429,51 +5937,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies how your DataSync agent connects to Amazon Web Services using a\n virtual private cloud (VPC) service endpoint. An agent that uses a VPC endpoint isn't accessible over the public internet.
" - } - }, - "com.amazonaws.datasync#PtolemyBoolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.datasync#PtolemyPassword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(?!.*[:\\\"][^:\"]*$).+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.datasync#PtolemyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^.{0,1024}$" - } - }, - "com.amazonaws.datasync#PtolemyUUID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.datasync#PtolemyUsername": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(?!.*[:\\\"][^:\"]*$).+$", - "smithy.api#sensitive": {} + "smithy.api#documentation": "Specifies how your DataSync agent connects to Amazon Web Services using a\n virtual private cloud (VPC) service endpoint. An agent that uses a VPC endpoint\n isn't accessible over the public internet.
" } }, "com.amazonaws.datasync#QopConfiguration": { @@ -7496,128 +5960,13 @@ "smithy.api#documentation": "The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS)\n cluster.
" } }, - "com.amazonaws.datasync#Recommendation": { - "type": "structure", - "members": { - "StorageType": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "A recommended Amazon Web Services storage service that you can migrate data to based on\n information that DataSync Discovery collects about your on-premises storage system.
" - } - }, - "StorageConfiguration": { - "target": "com.amazonaws.datasync#RecommendationsConfigMap", - "traits": { - "smithy.api#documentation": "Information about how you can set up a recommended Amazon Web Services storage\n service.
" - } - }, - "EstimatedMonthlyStorageCost": { - "target": "com.amazonaws.datasync#PtolemyString", - "traits": { - "smithy.api#documentation": "The estimated monthly cost of the recommended Amazon Web Services storage service.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details about an Amazon Web Services storage service that DataSync Discovery recommends for a\n resource in your on-premises storage system.
\nFor more information, see Recommendations\n provided by DataSync Discovery.
" - } - }, - "com.amazonaws.datasync#RecommendationStatus": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.datasync#Recommendations": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#Recommendation" - } - }, - "com.amazonaws.datasync#RecommendationsConfigMap": { - "type": "map", - "key": { - "target": "com.amazonaws.datasync#PtolemyString" - }, - "value": { - "target": "com.amazonaws.datasync#PtolemyString" - } - }, - "com.amazonaws.datasync#RemoveStorageSystem": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#RemoveStorageSystemRequest" - }, - "output": { - "target": "com.amazonaws.datasync#RemoveStorageSystemResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Permanently removes a storage system resource from DataSync Discovery, including the associated\n discovery jobs, collected data, and recommendations.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#RemoveStorageSystemRequest": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the storage system that you want to\n permanently remove from DataSync Discovery.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#RemoveStorageSystemResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#ReportDestination": { "type": "structure", "members": { "S3": { "target": "com.amazonaws.datasync#ReportDestinationS3", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task report.
" + "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task\n report.
" } } }, @@ -7644,13 +5993,13 @@ "BucketAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows\n DataSync to upload a task report to your S3 bucket. For more information, see\n Allowing\n DataSync to upload a task report to an Amazon S3 bucket.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task report.
" + "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task\n report.
" } }, "com.amazonaws.datasync#ReportLevel": { @@ -7693,7 +6042,7 @@ "ReportLevel": { "target": "com.amazonaws.datasync#ReportLevel", "traits": { - "smithy.api#documentation": "Specifies whether your task report includes errors only or successes and errors.
\nFor example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).
Specifies whether your task report includes errors only or successes and errors.
\nFor example, your report might mostly include only what didn't go well in your transfer\n (ERRORS_ONLY). At the same time, you want to verify that your task filter is\n working correctly. In this situation, you can get a list of what files DataSync\n successfully skipped and if something transferred that you didn't to transfer\n (SUCCESSES_AND_ERRORS).
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
" + "smithy.api#documentation": "Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your\n task to delete data in the destination that isn't in the source.
" } }, "Skipped": { @@ -7742,112 +6091,21 @@ "smithy.api#documentation": "Indicates whether DataSync is still working on your report, created a report, or\n can't create a complete report.
" } }, - "ErrorCode": { - "target": "com.amazonaws.datasync#string", - "traits": { - "smithy.api#documentation": "Indicates the code associated with the error if DataSync can't create a complete\n report.
" - } - }, - "ErrorDetail": { - "target": "com.amazonaws.datasync#string", - "traits": { - "smithy.api#documentation": "Provides details about issues creating a report.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Indicates whether DataSync created a complete task report for your\n transfer.
" - } - }, - "com.amazonaws.datasync#ResourceDetails": { - "type": "structure", - "members": { - "NetAppONTAPSVMs": { - "target": "com.amazonaws.datasync#NetAppONTAPSVMs", - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about storage virtual machines (SVMs) in your\n on-premises storage system.
" - } - }, - "NetAppONTAPVolumes": { - "target": "com.amazonaws.datasync#NetAppONTAPVolumes", - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about volumes in your on-premises storage\n system.
" - } - }, - "NetAppONTAPClusters": { - "target": "com.amazonaws.datasync#NetAppONTAPClusters", - "traits": { - "smithy.api#documentation": "The information that DataSync Discovery collects about the\n cluster\n in your on-premises storage system.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information provided by DataSync Discovery about the resources in your on-premises storage\n system.
" - } - }, - "com.amazonaws.datasync#ResourceFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.datasync#DiscoveryResourceFilter" - }, - "value": { - "target": "com.amazonaws.datasync#FilterMembers" - } - }, - "com.amazonaws.datasync#ResourceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.datasync#ResourceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#ResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.datasync#ResourceMetrics": { - "type": "structure", - "members": { - "Timestamp": { - "target": "com.amazonaws.datasync#Timestamp", - "traits": { - "smithy.api#documentation": "The time when DataSync Discovery collected this information from the\n resource.
" - } - }, - "P95Metrics": { - "target": "com.amazonaws.datasync#P95Metrics", - "traits": { - "smithy.api#documentation": "The types of performance data that DataSync Discovery collects about the on-premises storage system\n resource.
" - } - }, - "Capacity": { - "target": "com.amazonaws.datasync#Capacity", - "traits": { - "smithy.api#documentation": "The storage capacity of the on-premises storage system resource.
" - } - }, - "ResourceId": { - "target": "com.amazonaws.datasync#ResourceId", + "ErrorCode": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The universally unique identifier (UUID) of the on-premises storage system\n resource.
" + "smithy.api#documentation": "Indicates the code associated with the error if DataSync can't create a complete\n report.
" } }, - "ResourceType": { - "target": "com.amazonaws.datasync#DiscoveryResourceType", + "ErrorDetail": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The type of on-premises storage system resource.
" + "smithy.api#documentation": "Provides details about issues creating a report.
" } } }, "traits": { - "smithy.api#documentation": "Information, including performance data and capacity usage, provided by DataSync Discovery about a\n resource in your on-premises storage system.
" + "smithy.api#documentation": "Indicates whether DataSync created a complete task report for your\n transfer.
" } }, "com.amazonaws.datasync#S3BucketArn": { @@ -7872,7 +6130,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
\nFor more information, see Providing DataSync access to S3 buckets.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
\nFor more information, see Providing\n DataSync access to S3 buckets.
" } }, "com.amazonaws.datasync#S3ManifestConfig": { @@ -7888,14 +6146,14 @@ "BucketAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "Specifies the Identity and Access Management (IAM) role that allows DataSync to access your\n manifest. For more information, see Providing DataSync access to your manifest.
", + "smithy.api#documentation": "Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.
", "smithy.api#required": {} } }, "S3BucketArn": { "target": "com.amazonaws.datasync#S3BucketArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your\n manifest.
", "smithy.api#required": {} } }, @@ -8037,16 +6295,6 @@ } } }, - "com.amazonaws.datasync#SecretsManagerArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\\-0-9]+:[0-9]{12}:secret:" - } - }, "com.amazonaws.datasync#ServerHostname": { "type": "string", "traits": { @@ -8218,79 +6466,6 @@ "target": "com.amazonaws.datasync#NetworkInterfaceArn" } }, - "com.amazonaws.datasync#StartDiscoveryJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#StartDiscoveryJobRequest" - }, - "output": { - "target": "com.amazonaws.datasync#StartDiscoveryJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Runs a DataSync discovery job on your on-premises storage system. If you haven't added the\n storage system to DataSync Discovery yet, do this first by using the AddStorageSystem\n operation.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#StartDiscoveryJobRequest": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want\n to run the discovery job on.
", - "smithy.api#required": {} - } - }, - "CollectionDurationMinutes": { - "target": "com.amazonaws.datasync#CollectionDurationMinutes", - "traits": { - "smithy.api#documentation": "Specifies in minutes how long you want the discovery job to run.
\nFor more accurate recommendations, we recommend a duration of at least 14 days. Longer\n durations allow time to collect a sufficient number of data points and provide a realistic\n representation of storage performance and utilization.
\nSpecifies a client token to make sure requests with this API operation are idempotent. If\n you don't specify a client token, DataSync generates one for you automatically.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services\n resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#StartDiscoveryJobResponse": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "The ARN of the discovery job that you started.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#StartTaskExecution": { "type": "operation", "input": { @@ -8375,110 +6550,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#StopDiscoveryJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#StopDiscoveryJobRequest" - }, - "output": { - "target": "com.amazonaws.datasync#StopDiscoveryJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Stops a running DataSync discovery job.
\nYou can stop a discovery job anytime. A job that's stopped before it's scheduled to end\n likely will provide you some information about your on-premises storage system resources. To\n get recommendations for a stopped job, you must use the GenerateRecommendations operation.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#StopDiscoveryJobRequest": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#StopDiscoveryJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.datasync#StorageSystemArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.datasync#StorageSystemConnectivityStatus": { - "type": "enum", - "members": { - "PASS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASS" - } - }, - "FAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAIL" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.datasync#StorageSystemList": { - "type": "list", - "member": { - "target": "com.amazonaws.datasync#StorageSystemListEntry" - } - }, - "com.amazonaws.datasync#StorageSystemListEntry": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of an on-premises storage system that you added to\n DataSync Discovery.
" - } - }, - "Name": { - "target": "com.amazonaws.datasync#Name", - "traits": { - "smithy.api#documentation": "The name of an on-premises storage system that you added to DataSync Discovery.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information that identifies an on-premises storage system that you're using with\n DataSync Discovery.
" - } - }, "com.amazonaws.datasync#StorageVirtualMachineArn": { "type": "string", "traits": { @@ -8672,7 +6743,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of objects that DataSync finds at your destination location. This counter is only applicable if you configure your task to delete data in the destination that isn't in the source.
" + "smithy.api#documentation": "The number of objects that DataSync finds at your destination location. This\n counter is only applicable if you configure your task to delete data in the destination that isn't in the\n source.
" } } }, @@ -8704,7 +6775,7 @@ "TaskMode": { "target": "com.amazonaws.datasync#TaskMode", "traits": { - "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data\n transfer.
" } } }, @@ -8736,7 +6807,7 @@ "TransferDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The time in milliseconds that your task execution was in the TRANSFERRING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync transfers your data.
The time in milliseconds that your task execution was in the TRANSFERRING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync transfers your data.
The time in milliseconds that your task execution was in the VERIFYING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync verifies your data's integrity.
The time in milliseconds that your task execution was in the VERIFYING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync verifies your data's\n integrity.
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data\n transfer.
" } } }, @@ -8957,25 +7028,25 @@ "Destination": { "target": "com.amazonaws.datasync#ReportDestination", "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task report. For more\n information, see Task reports.
" + "smithy.api#documentation": "Specifies the Amazon S3 bucket where DataSync uploads your task report.\n For more information, see Task\n reports.
" } }, "OutputType": { "target": "com.amazonaws.datasync#ReportOutputType", "traits": { - "smithy.api#documentation": "Specifies the type of task report that you want:
\n\n SUMMARY_ONLY: Provides necessary details about your task, including the number of\n files, objects, and directories transferred and transfer duration.
\n STANDARD: Provides complete details about your task, including a full list of\n files, objects, and directories that were transferred, skipped, verified, and more.
Specifies the type of task report that you want:
\n\n SUMMARY_ONLY: Provides necessary details about your task, including the\n number of files, objects, and directories transferred and transfer duration.
\n STANDARD: Provides complete details about your task, including a full\n list of files, objects, and directories that were transferred, skipped, verified, and\n more.
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
\n\n ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip,\n verify, and delete.
\n SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable\n to transfer, skip, verify, and delete.
Specifies whether you want your task report to include only what went wrong with your\n transfer or a list of what succeeded and didn't.
\n\n ERRORS_ONLY: A report shows what DataSync was unable to\n transfer, skip, verify, and delete.
\n SUCCESSES_AND_ERRORS: A report shows what DataSync was able and\n unable to transfer, skip, verify, and delete.
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.
Specifies whether your task report includes the new version of each object transferred\n into an S3 bucket. This only applies if you enable versioning on your\n bucket. Keep in mind that setting this to INCLUDE can increase the\n duration of your task execution.
Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.
\nFor more information, see Task\n reports.
" + "smithy.api#documentation": "Specifies how you want to configure a task report, which provides detailed information\n about for your DataSync transfer.
\nFor more information, see Task reports.
" } }, "com.amazonaws.datasync#TaskSchedule": { @@ -9022,7 +7093,7 @@ "DisabledReason": { "target": "com.amazonaws.datasync#ScheduleDisabledReason", "traits": { - "smithy.api#documentation": "Provides a reason if the task schedule is disabled.
\nIf your schedule is disabled by USER, you see a Manually disabled by user. message.
If your schedule is disabled by SERVICE, you see an error message to help you\n understand why the task keeps failing. For information on resolving DataSync errors,\n see Troubleshooting issues with DataSync transfers.
Provides a reason if the task schedule is disabled.
\nIf your schedule is disabled by USER, you see a Manually disabled by\n user. message.
If your schedule is disabled by SERVICE, you see an error message to help you\n understand why the task keeps failing. For information on resolving DataSync errors,\n see Troubleshooting issues with DataSync transfers.
Provides information about your DataSync\n task schedule.
" + "smithy.api#documentation": "Provides information about your DataSync\n task\n schedule.
" } }, "com.amazonaws.datasync#TaskStatus": { @@ -9071,44 +7142,9 @@ } } }, - "com.amazonaws.datasync#Throughput": { - "type": "structure", - "members": { - "Read": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput related to read operations.
" - } - }, - "Write": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput related to write operations.
" - } - }, - "Other": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak throughput unrelated to read and write operations.
" - } - }, - "Total": { - "target": "com.amazonaws.datasync#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "Peak total throughput on your on-premises storage system resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The throughput peaks for an on-premises storage system volume. Each data point represents\n the 95th percentile peak value during a 1-hour interval.
" - } - }, "com.amazonaws.datasync#Time": { "type": "timestamp" }, - "com.amazonaws.datasync#Timestamp": { - "type": "timestamp" - }, "com.amazonaws.datasync#TransferMode": { "type": "enum", "members": { @@ -9254,58 +7290,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.datasync#UpdateDiscoveryJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.datasync#UpdateDiscoveryJobRequest" - }, - "output": { - "target": "com.amazonaws.datasync#UpdateDiscoveryJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.datasync#InternalException" - }, - { - "target": "com.amazonaws.datasync#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Edits a DataSync discovery job configuration.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#UpdateDiscoveryJobRequest": { - "type": "structure", - "members": { - "DiscoveryJobArn": { - "target": "com.amazonaws.datasync#DiscoveryJobArn", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want to\n update.
", - "smithy.api#required": {} - } - }, - "CollectionDurationMinutes": { - "target": "com.amazonaws.datasync#CollectionDurationMinutes", - "traits": { - "smithy.api#documentation": "Specifies in minutes how long that you want the discovery job to run. (You can't set this\n parameter to less than the number of minutes that the job has already run for.)
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#UpdateDiscoveryJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#UpdateLocationAzureBlob": { "type": "operation", "input": { @@ -9323,7 +7307,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with Azure Blob Storage.
" + "smithy.api#documentation": "Modifies the following configurations of the Microsoft Azure Blob Storage transfer\n location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with Azure Blob Storage.
" } }, "com.amazonaws.datasync#UpdateLocationAzureBlobRequest": { @@ -9345,13 +7329,13 @@ "AuthenticationType": { "target": "com.amazonaws.datasync#AzureBlobAuthenticationType", "traits": { - "smithy.api#documentation": "Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
" + "smithy.api#documentation": "Specifies the authentication method DataSync uses to access your Azure Blob\n Storage. DataSync can access blob storage using a shared access signature\n (SAS).
" } }, "SasConfiguration": { "target": "com.amazonaws.datasync#AzureBlobSasConfiguration", "traits": { - "smithy.api#documentation": "Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
" + "smithy.api#documentation": "Specifies the SAS configuration that allows DataSync to access your Azure Blob\n Storage.
" } }, "BlobType": { @@ -9363,13 +7347,13 @@ "AccessTier": { "target": "com.amazonaws.datasync#AzureAccessTier", "traits": { - "smithy.api#documentation": "Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
" + "smithy.api#documentation": "Specifies the access tier that you want your objects or files transferred into. This only\n applies when using the location as a transfer destination. For more information, see Access tiers.
" } }, "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for your transfer.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect\n with your Azure Blob Storage container.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for your transfer.
" } } }, @@ -9401,7 +7385,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with Amazon EFS.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon EFS transfer\n location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with Amazon EFS.
" } }, "com.amazonaws.datasync#UpdateLocationEfsRequest": { @@ -9410,32 +7394,32 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that\n you're updating.
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or\n destination location).
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing restricted Amazon EFS file systems.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing\n restricted Amazon EFS file systems.
" } }, "FileSystemAccessRoleArn": { "target": "com.amazonaws.datasync#UpdatedEfsIamRoleArn", "traits": { - "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync IAM role for Amazon EFS file system access.
" + "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync\n IAM role for Amazon EFS file system access.
" } }, "InTransitEncryption": { "target": "com.amazonaws.datasync#EfsInTransitEncryption", "traits": { - "smithy.api#documentation": "Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\n encryption when it transfers data to or from your Amazon EFS file system.
\nIf you specify an access point using AccessPointArn or an IAM\n role using FileSystemAccessRoleArn, you must set this parameter to\n TLS1_2.
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\n encryption when it transfers data to or from your Amazon EFS file system.
\nIf you specify an access point using AccessPointArn or an IAM\n role using FileSystemAccessRoleArn, you must set this parameter to\n TLS1_2.
Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for Lustre.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon FSx for Lustre\n transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with FSx for Lustre.
" } }, "com.amazonaws.datasync#UpdateLocationFsxLustreRequest": { @@ -9476,14 +7460,14 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location\n that you're updating.
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).
Specifies a mount path for your FSx for Lustre file system. The path can include\n subdirectories.
\nWhen the location is used as a source, DataSync reads data from the mount path.\n When the location is used as a destination, DataSync writes data to the mount path.\n If you don't include this parameter, DataSync uses the file system's root directory\n (/).
Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for ONTAP.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP\n transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with FSx for ONTAP.
" } }, "com.amazonaws.datasync#UpdateLocationFsxOntapRequest": { @@ -9524,7 +7508,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location\n that you're updating.
", "smithy.api#required": {} } }, @@ -9537,7 +7521,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#FsxOntapSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nSpecifies a path to the file share in the storage virtual machine (SVM) where you want to\n transfer data to or from.
\nYou can specify a junction path (also known as a mount point), qtree path (for NFS file\n shares), or share name (for SMB file shares). For example, your mount path might be\n /vol1, /vol1/tree1, or /share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
\nModifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for OpenZFS.
\nRequest parameters related to SMB aren't supported with the\n UpdateLocationFsxOpenZfs operation.
Modifies the following configuration parameters of the Amazon FSx for OpenZFS\n transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with FSx for OpenZFS.
\nRequest parameters related to SMB aren't supported with the\n UpdateLocationFsxOpenZfs operation.
Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer\n location that you're updating.
", "smithy.api#required": {} } }, @@ -9588,7 +7572,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file\n system is a source or destination location).
Specifies a subdirectory in the location's path that must begin with /fsx.\n DataSync uses this subdirectory to read or write data (depending on whether the\n file system is a source or destination location).
Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with FSx for Windows File Server.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon FSx for Windows File Server\n transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with FSx for Windows File Server.
" } }, "com.amazonaws.datasync#UpdateLocationFsxWindowsRequest": { @@ -9629,26 +7613,26 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the ARN of the FSx for Windows File Server transfer location that you're\n updating.
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", "traits": { - "smithy.api#documentation": "Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file\n system is a source or destination location).
" + "smithy.api#documentation": "Specifies a mount path for your file system using forward slashes. DataSync uses\n this subdirectory to read or write data (depending on whether the file system is a source or\n destination location).
" } }, "Domain": { "target": "com.amazonaws.datasync#UpdateSmbDomain", "traits": { - "smithy.api#documentation": "Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
" + "smithy.api#documentation": "Specifies the name of the Windows domain that your FSx for Windows File Server file system\n belongs to.
\nIf you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.
" } }, "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "Specifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.
\nFor information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
" + "smithy.api#documentation": "Specifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.
\nFor information about choosing a user with the right level of access for your transfer,\n see required permissions for FSx for Windows File Server locations.
" } }, "Password": { @@ -9686,7 +7670,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the Hadoop Distributed File\n System (HDFS) transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an HDFS cluster.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Hadoop Distributed File System\n (HDFS) transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with an HDFS cluster.
" } }, "com.amazonaws.datasync#UpdateLocationHdfsRequest": { @@ -9756,7 +7740,7 @@ "KerberosKeytab": { "target": "com.amazonaws.datasync#KerberosKeytabFile", "traits": { - "smithy.api#documentation": "The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address. If you use the CLI, it performs base64 encoding for you. Otherwise,\n provide the base64-encoded text.
" + "smithy.api#documentation": "The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address.
" } }, "KerberosKrb5Conf": { @@ -9768,7 +7752,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your\n HDFS cluster.
" } } }, @@ -9800,7 +7784,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.
\nFor more information, see Configuring transfers with an\n NFS file server.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Network File System (NFS) transfer\n location that you're using with DataSync.
\nFor more information, see Configuring transfers with an NFS\n file server.
" } }, "com.amazonaws.datasync#UpdateLocationNfsRequest": { @@ -9816,13 +7800,13 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "Specifies the export path in your NFS file server that you want DataSync to\n mount.
\nThis path (or a subdirectory of the path) is where DataSync transfers data to\n or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
" + "smithy.api#documentation": "Specifies the export path in your NFS file server that you want DataSync to\n mount.
\nThis path (or a subdirectory of the path) is where DataSync transfers data to or\n from. For information on configuring an export for DataSync, see Accessing NFS file servers.
" } }, "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "Specifies the DNS name or IP version 4 (IPv4) address of the NFS file\n server that your DataSync agent connects to.
" + "smithy.api#documentation": "Specifies the DNS name or IP version 4 (IPv4) address of the NFS file server that your\n DataSync agent connects to.
" } }, "OnPremConfig": { @@ -9860,7 +7844,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an object storage system.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the object storage transfer location\n that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with an object storage system.
" } }, "com.amazonaws.datasync#UpdateLocationObjectStorageRequest": { @@ -9894,7 +7878,7 @@ "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync\n agent connects to.
" + "smithy.api#documentation": "Specifies the domain name or IP version 4 (IPv4) address of the object storage server that\n your DataSync agent connects to.
" } }, "AccessKey": { @@ -9918,7 +7902,7 @@ "ServerCertificate": { "target": "com.amazonaws.datasync#ObjectStorageCertificate", "traits": { - "smithy.api#documentation": "Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single .pem file with a full certificate chain (for example,\n file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
\nThe object storage system's certificate
\nAll intermediate certificates (if there are any)
\nThe root certificate of the signing CA
\nYou can concatenate your certificates into a .pem file (which can be up to\n 32768 bytes before base64 encoding). The following example cat command creates an\n object_storage_certificates.pem file that includes three certificates:
\n cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem\n
To use this parameter, configure ServerProtocol to HTTPS.
Updating this parameter doesn't interfere with tasks that you have in progress.
" + "smithy.api#documentation": "Specifies a certificate chain for DataSync to authenticate with your object\n storage system if the system uses a private or self-signed certificate authority (CA). You\n must specify a single .pem file with a full certificate chain (for example,\n file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
\nThe object storage system's certificate
\nAll intermediate certificates (if there are any)
\nThe root certificate of the signing CA
\nYou can concatenate your certificates into a .pem file (which can be up to\n 32768 bytes before base64 encoding). The following example cat command creates an\n object_storage_certificates.pem file that includes three certificates:
\n cat object_server_certificate.pem intermediate_certificate.pem\n ca_root_certificate.pem > object_storage_certificates.pem\n
To use this parameter, configure ServerProtocol to HTTPS.
Updating this parameter doesn't interfere with tasks that you have in progress.
" } } }, @@ -9950,7 +7934,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.
\nBefore you begin, make sure that you read the following topics:
\n\n Storage\n class considerations with Amazon S3 locations\n
\nModifies the following configuration parameters of the Amazon S3 transfer location\n that you're using with DataSync.
\nBefore you begin, make sure that you read the following topics:
\n\n Storage\n class considerations with Amazon S3 locations\n
\nSpecifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that\n you're updating.
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#S3Subdirectory", "traits": { - "smithy.api#documentation": "Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).
\nDataSync can't transfer objects with a prefix that begins with a slash\n (/) or includes //, /./, or\n /../ patterns. For example:
\n /photos\n
\n photos//2006/January\n
\n photos/./2006/February\n
\n photos/../2006/March\n
Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).
\nDataSync can't transfer objects with a prefix that begins with a slash (/)\n or includes //, /./, or /../ patterns. For\n example:
\n /photos\n
\n photos//2006/January\n
\n photos/./2006/February\n
\n photos/../2006/March\n
Specifies the storage class that you want your objects to use when Amazon S3 is a\n transfer destination.
\nFor buckets in Amazon Web Services Regions, the storage class defaults to\n STANDARD. For buckets on Outposts, the storage class defaults to\n OUTPOSTS.
For more information, see Storage class\n considerations with Amazon S3 transfers.
" + "smithy.api#documentation": "Specifies the storage class that you want your objects to use when Amazon S3 is a\n transfer destination.
\nFor buckets in Amazon Web Services Regions, the storage class defaults to\n STANDARD. For buckets on Outposts, the storage class defaults to\n OUTPOSTS.
For more information, see Storage class\n considerations with Amazon S3 transfers.
" } }, "S3Config": { @@ -10007,7 +7991,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the following configuration parameters of the Server Message Block\n (SMB) transfer location that you're using with DataSync.
\nFor more information, see Configuring DataSync transfers with an SMB file server.
" + "smithy.api#documentation": "Modifies the following configuration parameters of the Server Message Block (SMB) transfer\n location that you're using with DataSync.
\nFor more information, see Configuring DataSync\n transfers with an SMB file server.
" } }, "com.amazonaws.datasync#UpdateLocationSmbRequest": { @@ -10023,7 +8007,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "Specifies the name of the share exported by your SMB file server where DataSync\n will read or write data. You can include a subdirectory in the share path (for example,\n /path/to/subdirectory). Make sure that other SMB clients in your network can\n also mount this path.
To copy all data in the specified subdirectory, DataSync must be able to mount\n the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
" + "smithy.api#documentation": "Specifies the name of the share exported by your SMB file server where DataSync\n will read or write data. You can include a subdirectory in the share path (for example,\n /path/to/subdirectory). Make sure that other SMB clients in your network can\n also mount this path.
To copy all data in the specified subdirectory, DataSync must be able to mount\n the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.
" } }, "ServerHostname": { @@ -10041,7 +8025,7 @@ "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "Specifies the Windows domain name that your SMB file server belongs to. This parameter\n applies only if AuthenticationType is set to NTLM.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
" + "smithy.api#documentation": "Specifies the Windows domain name that your SMB file server belongs to. This parameter\n applies only if AuthenticationType is set to NTLM.
If you have multiple domains in your environment, configuring this parameter makes sure\n that DataSync connects to the right file server.
" } }, "Password": { @@ -10080,7 +8064,7 @@ "KerberosKeytab": { "target": "com.amazonaws.datasync#KerberosKeytabFile", "traits": { - "smithy.api#documentation": "Specifies your Kerberos key table (keytab) file, which includes mappings between your\n Kerberos principal and encryption keys.
\nThe file must be base64 encoded. If you're using the CLI, the encoding is\n done for you.
\nTo avoid task execution errors, make sure that the Kerberos principal that you use to\n create the keytab file matches exactly what you specify for KerberosPrincipal.
Specifies your Kerberos key table (keytab) file, which includes mappings between your\n Kerberos principal and encryption keys.
\nTo avoid task execution errors, make sure that the Kerberos principal that you use to\n create the keytab file matches exactly what you specify for\n KerberosPrincipal.
Modifies some configurations of an on-premises storage system resource that you're using\n with DataSync Discovery.
", - "smithy.api#endpoint": { - "hostPrefix": "discovery-" - } - } - }, - "com.amazonaws.datasync#UpdateStorageSystemRequest": { - "type": "structure", - "members": { - "StorageSystemArn": { - "target": "com.amazonaws.datasync#StorageSystemArn", - "traits": { - "smithy.api#documentation": "Specifies the ARN of the on-premises storage system that you want reconfigure.
", - "smithy.api#required": {} - } - }, - "ServerConfiguration": { - "target": "com.amazonaws.datasync#DiscoveryServerConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the server name and network port required to connect with your on-premises\n storage system's management interface.
" - } - }, - "AgentArns": { - "target": "com.amazonaws.datasync#DiscoveryAgentArnList", - "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads\n your on-premises storage system. You can only specify one ARN.
" - } - }, - "Name": { - "target": "com.amazonaws.datasync#Name", - "traits": { - "smithy.api#documentation": "Specifies a familiar name for your on-premises storage system.
" - } - }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", - "traits": { - "smithy.api#documentation": "Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging\n discovery job events.
" - } - }, - "Credentials": { - "target": "com.amazonaws.datasync#Credentials", - "traits": { - "smithy.api#documentation": "Specifies the user name and password for accessing your on-premises storage system's\n management interface.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.datasync#UpdateStorageSystemResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.datasync#UpdateTask": { "type": "operation", "input": { @@ -10203,7 +8112,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of a task, which defines where and how DataSync transfers your data.
" + "smithy.api#documentation": "Updates the configuration of a task, which defines where and how\n DataSync transfers your data.
" } }, "com.amazonaws.datasync#UpdateTaskExecution": { @@ -10223,7 +8132,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of a running DataSync task execution.
\nCurrently, the only Option that you can modify with\n UpdateTaskExecution is \n BytesPerSecond\n , which throttles bandwidth for a running or queued\n task execution.
Updates the configuration of a running DataSync task execution.
\nCurrently, the only Option that you can modify with\n UpdateTaskExecution is \n BytesPerSecond\n , which throttles bandwidth for a running or queued task\n execution.
Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more\n information and examples, see Specifying what DataSync transfers by using filters.
" + "smithy.api#documentation": "Specifies exclude filters that define the files, objects, and folders in your source\n location that you don't want DataSync to transfer. For more information and\n examples, see Specifying what DataSync transfers by using filters.
" } }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" + "smithy.api#documentation": "Specifies a schedule for when you want your task to run. For more information, see Scheduling your\n task.
" } }, "Name": { @@ -10300,13 +8209,13 @@ "ManifestConfig": { "target": "com.amazonaws.datasync#ManifestConfig", "traits": { - "smithy.api#documentation": "Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
\nWhen using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a manifest configuration, specify this parameter as empty.
" + "smithy.api#documentation": "Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
\nWhen using this parameter, your caller identity (the IAM role that you're\n using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a manifest configuration, specify this parameter as empty.
" } }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
\nWhen using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a task report configuration, specify this parameter as empty.
" + "smithy.api#documentation": "Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
\nWhen using this parameter, your caller identity (the IAM role that you're\n using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a task report configuration, specify this parameter as empty.
" } } }, diff --git a/models/deadline/service/2023-10-12/deadline-2023-10-12.json b/models/deadline/service/2023-10-12/deadline-2023-10-12.json index 3341836d..2961e3d2 100644 --- a/models/deadline/service/2023-10-12/deadline-2023-10-12.json +++ b/models/deadline/service/2023-10-12/deadline-2023-10-12.json @@ -22,7 +22,7 @@ "selections": { "target": "com.amazonaws.deadline#AcceleratorSelections", "traits": { - "smithy.api#documentation": "A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances\n that provide these capabilities will be used. For example, if you specify both L4 and T4\n chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip\n installed.
", + "smithy.api#documentation": "A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
", "smithy.api#required": {} } }, @@ -34,7 +34,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the GPU accelerators used for jobs processed by a\n fleet.
" + "smithy.api#documentation": "Provides information about the GPU accelerators used for jobs processed by a fleet.
" } }, "com.amazonaws.deadline#AcceleratorCountRange": { @@ -55,7 +55,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the maximum and minimum number of GPU accelerators required for a worker\n instance..
" + "smithy.api#documentation": "Defines the maximum and minimum number of GPU accelerators required for a worker instance..
" } }, "com.amazonaws.deadline#AcceleratorName": { @@ -102,7 +102,7 @@ "name": { "target": "com.amazonaws.deadline#AcceleratorName", "traits": { - "smithy.api#documentation": "The name of the chip used by the GPU accelerator.
\nIf you specify l4 as the name of the accelerator, you must specify\n latest or grid:r550 as the runtime.
The available GPU accelerators are:
\n\n t4 - NVIDIA T4 Tensor Core GPU
\n a10g - NVIDIA A10G Tensor Core GPU
\n l4 - NVIDIA L4 Tensor Core GPU
\n l40s - NVIDIA L40S Tensor Core GPU
The name of the chip used by the GPU accelerator.
If you specify l4 as the name of the accelerator, you must specify latest or grid:r550 as the runtime.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU
a10g - NVIDIA A10G Tensor Core GPU
l4 - NVIDIA L4 Tensor Core GPU
l40s - NVIDIA L40S Tensor Core GPU
Specifies the runtime driver to use for the GPU accelerator. You must use the same\n runtime for all GPUs.
\nYou can choose from the following runtimes:
\n\n latest - Use the latest runtime available for the chip. If you\n specify latest and a new version of the runtime is released, the new\n version of the runtime is used.
\n grid:r550 - NVIDIA vGPU software 17\n
\n grid:r535 - NVIDIA vGPU software 16\n
If you don't specify a runtime, Deadline Cloud uses latest as the default. However,\n if you have multiple accelerators and specify latest for some and leave others\n blank, Deadline Cloud raises an exception.
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r550 - NVIDIA vGPU software 17
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Deadline Cloud raises an exception.
Defines the maximum and minimum amount of memory, in MiB, to use for the\n accelerator.
" + "smithy.api#documentation": "Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.
" } }, "com.amazonaws.deadline#AcceleratorType": { @@ -929,7 +929,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are\n scoped down to have read-only access.
", + "smithy.api#documentation": "Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -1105,7 +1105,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are\n scoped down to have read-only access.
", + "smithy.api#documentation": "Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -1545,7 +1545,7 @@ "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { - "smithy.api#documentation": "The farm ID of the worker that's fetching job details. The worker must have an\n assignment on a job to fetch job details.
", + "smithy.api#documentation": "The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1553,7 +1553,7 @@ "fleetId": { "target": "com.amazonaws.deadline#FleetId", "traits": { - "smithy.api#documentation": "The fleet ID of the worker that's fetching job details. The worker must have an\n assignment on a job to fetch job details.
", + "smithy.api#documentation": "The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1629,7 +1629,7 @@ "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "A description for the budget action to add.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nA description for the budget action to add.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The status of the budget.
\n\n ACTIVE\u2013The budget is being evaluated.
\n INACTIVE\u2013The budget is inactive. This can include Expired,\n Canceled, or deleted Deleted statuses.
The status of the budget.
ACTIVE\u2013The budget is being evaluated.
INACTIVE\u2013The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
The display name of the budget summary to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the budget summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget summary.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the budget summary.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Your request has conflicting operations. This can occur if you're trying to perform more\n than one operation on the same resource at the same time.
", + "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2147,7 +2147,7 @@ "targetS3Location": { "target": "com.amazonaws.deadline#S3Location", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket name and key where you would like to add a copy of the job\n template.
", + "smithy.api#documentation": "The Amazon S3 bucket name and key where you would like to add a copy of the job template.
", "smithy.api#required": {} } } @@ -2265,7 +2265,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the budget.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Creates a farm to allow space for queues and fleets. Farms are the space where the\n components of your renders gather and are pieced together in the cloud. Farms contain\n budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for\n large projects.
", + "smithy.api#documentation": "Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2383,7 +2383,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the farm.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Creates a fleet. Fleets gather information relating to compute, or capacity, for renders\n within your farms. You can choose to manage your own capacity or opt to have fleets fully\n managed by Deadline Cloud.
", + "smithy.api#documentation": "Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2503,7 +2503,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the fleet.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the fleet.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The maximum number of workers for the fleet.
", + "smithy.api#documentation": "The maximum number of workers for the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The configuration settings for the fleet. Customer managed fleets are self-managed.\n Service managed Amazon EC2 fleets are managed by Deadline Cloud.
", + "smithy.api#documentation": "The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
", "smithy.api#required": {} } }, @@ -2547,6 +2547,12 @@ "traits": { "smithy.api#documentation": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
" } + }, + "hostConfiguration": { + "target": "com.amazonaws.deadline#HostConfiguration", + "traits": { + "smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + } } }, "traits": { @@ -2605,7 +2611,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule\n and run work on available workers. For more information, see Deadline Cloud\n jobs.
", + "smithy.api#documentation": "Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2659,7 +2665,7 @@ "priority": { "target": "com.amazonaws.deadline#JobPriority", "traits": { - "smithy.api#documentation": "The priority of the job. The highest priority (first scheduled) is 100. When two jobs\n have the same priority, the oldest job is scheduled first.
", + "smithy.api#documentation": "The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
", "smithy.api#required": {} } }, @@ -2672,7 +2678,7 @@ "attachments": { "target": "com.amazonaws.deadline#Attachments", "traits": { - "smithy.api#documentation": "The attachments for the job. Attach files required for the job to run to a render\n job.
" + "smithy.api#documentation": "The attachments for the job. Attach files required for the job to run to a render job.
" } }, "storageProfileId": { @@ -2685,7 +2691,7 @@ "target": "com.amazonaws.deadline#CreateJobTargetTaskRunStatus", "traits": { "smithy.api#default": "READY", - "smithy.api#documentation": "The initial job status when it is created. Jobs that are created with a\n SUSPENDED status will not run until manually requeued.
The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.
If you don't specify the maxWorkerCount, Deadline Cloud won't throttle\n the number of workers used to process the job.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.
Creates a license endpoint to integrate your various licensed software used for\n rendering on Deadline Cloud.
", + "smithy.api#documentation": "Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2908,7 +2914,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Creates a limit that manages the distribution of shared resources, such as floating\n licenses. A limit can throttle work assignments, help manage workloads, and track current\n usage. Before you use a limit, you must associate the limit with one or more queues.
\nYou must add the amountRequirementName to a step in a job template to\n declare the limit requirement.
Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName to a step in a job template to declare the limit requirement.
The display name of the limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.
\nThe maxCount must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
A description of the limit. A description helps you identify the purpose of the\n limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nA description of the limit. A description helps you identify the purpose of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
A unique identifier for the limit. Use this identifier in other operations, such as\n CreateQueueLimitAssociation and DeleteLimit.
A unique identifier for the limit. Use this identifier in other operations, such as CreateQueueLimitAssociation and DeleteLimit.
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and\n fleets. After you submit a job, you can track the progress of the tasks and steps that make\n up the job, and then download the job's results.
", + "smithy.api#documentation": "Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3052,7 +3058,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The name that you give the monitor that is displayed in the Deadline Cloud console.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe name that you give the monitor that is displayed in the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The subdomain to use when creating the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.
", + "smithy.api#documentation": "The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user\n that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud\n resources.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
", "smithy.api#required": {} } } @@ -3148,7 +3154,7 @@ "s3:ListBucket" ] }, - "smithy.api#documentation": "Creates a queue to coordinate the order in which jobs run on a farm. A queue can also\n specify where to pull resources and indicate where to output completed jobs.
", + "smithy.api#documentation": "Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3238,7 +3244,7 @@ "priority": { "target": "com.amazonaws.deadline#Priority", "traits": { - "smithy.api#documentation": "Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the\n highest priority (activated first and deactivated last). If two environments share the same\n priority value, the environment created first takes higher priority.
", + "smithy.api#documentation": "Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.
", "smithy.api#required": {} } }, @@ -3399,7 +3405,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Associates a limit with a particular queue. After the limit is associated, all workers\n for jobs that specify the limit associated with the queue are subject to the limit. You\n can't associate two limits with the same amountRequirementName to the same\n queue.
Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
The display name of the queue.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the queue.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3\n prefix.
" + "smithy.api#documentation": "The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
" } }, "roleArn": { @@ -3588,7 +3594,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Creates a storage profile that specifies the operating system, file type, and file\n location of resources used on a farm.
", + "smithy.api#documentation": "Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3622,7 +3628,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the storage profile.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the storage profile.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Creates a worker. A worker tells your instance how much processing power (vCPU), and\n memory (GiB) you\u2019ll need to assemble the digital assets held within a particular instance.\n You can specify certain instance types to use, or let the worker know which instances types\n to exclude.
", + "smithy.api#documentation": "Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you\u2019ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
Specifies whether tags associated with a fleet are attached to workers when the worker\n is launched.
\nWhen the tagPropagationMode is set to\n PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is\n attached to workers when they launch. If the tags for a fleet change, the tags associated\n with running workers do not change.
If you don't specify tagPropagationMode, the default is\n NO_PROPAGATION.
Specifies whether tags associated with a fleet are attached to workers when the worker is launched.
When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.
If you don't specify tagPropagationMode, the default is NO_PROPAGATION.
The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your\n projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions\n specific to their job function.
\nWith Deadline Cloud, content production teams can deploy resources for their workforce\n securely in the cloud, reducing the costs of added physical infrastructure. Keep your\n content production operations secure, while allowing your contributors to access the tools\n they need, such as scalable high-speed storage, licenses, and cost management\n services.
", + "smithy.api#documentation": "The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.
With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.
", "smithy.api#title": "AWSDeadlineCloud", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5166,7 +5172,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Removes a limit from the specified farm. Before you delete a limit you must use the\n DeleteQueueLimitAssociation operation to remove the association with any\n queues.
Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.
Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and\n attach farms to the monitor.
", + "smithy.api#documentation": "Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -5335,7 +5341,7 @@ "monitorId": { "target": "com.amazonaws.deadline#MonitorId", "traits": { - "smithy.api#documentation": "The unique identifier of the monitor to delete. This ID is returned by the\n CreateMonitor operation, and is included in the response to the\n GetMonitor operation.
The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.
Deletes a queue.
\nYou can't recover the jobs in a queue if you delete the queue. Deleting the queue\n also deletes the jobs in that queue.
\nDeletes a queue.
You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.
Removes the association between a queue and a limit. You must use the\n UpdateQueueLimitAssociation operation to set the status to\n STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or\n STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately.\n Use the GetQueueLimitAssociation operation to see if the status changed to\n STOPPED before deleting the association.
Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.
The unique identifier of the farm that contains the queue and limit to\n disassociate.
", + "smithy.api#documentation": "The unique identifier of the farm that contains the queue and limit to disassociate.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6751,7 +6757,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the farm.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the fleet summary to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the fleet summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The status of the budget.
\n\n ACTIVE\u2013Get a budget being evaluated.
\n INACTIVE\u2013Get an inactive budget. This can include expired,\n canceled, or deleted statuses.
The status of the budget.
ACTIVE\u2013Get a budget being evaluated.
INACTIVE\u2013Get an inactive budget. This can include expired, canceled, or deleted statuses.
The display name of the budget.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the budget.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the farm.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the farm.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the fleet.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the fleet.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the fleet.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The Auto Scaling status of the fleet. Either GROWING, STEADY, or\n SHRINKING.
The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + } + }, "capabilities": { "target": "com.amazonaws.deadline#FleetCapabilities", "traits": { - "smithy.api#documentation": "Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to\n attribute names and values.
" + "smithy.api#documentation": "Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
" } }, "roleArn": { @@ -8132,13 +8144,13 @@ "description": { "target": "com.amazonaws.deadline#JobDescription", "traits": { - "smithy.api#documentation": "The description of the job.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the job.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.
If you don't set the maxWorkerCount when you create a job, this value is\n not returned in the response.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.
The display name of the limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.
\nThe maxValue must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
The number of resources from the limit that are being used by jobs. The result is\n delayed and may not be the count at the time that you called the operation.
", + "smithy.api#documentation": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "The description of the limit that helps identify what the limit is used for.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the limit that helps identify what the limit is used for.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The unique identifier for the monitor. This ID is returned by the\n CreateMonitor operation.
The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
The name used to identify the monitor on the Deadline Cloud console.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe name used to identify the monitor on the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The subdomain used for the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.
", + "smithy.api#documentation": "The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.deadline#Url", "traits": { - "smithy.api#documentation": "The complete URL of the monitor. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.
", + "smithy.api#documentation": "The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to\n access Deadline Cloud resources.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
", "smithy.api#required": {} } }, @@ -9197,14 +9209,14 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the queue.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the queue.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The status of the queue.
\n\n ACTIVE\u2013The queue is active.
\n SCHEDULING\u2013The queue is scheduling.
\n SCHEDULING_BLOCKED\u2013The queue scheduling is blocked. See the\n provided reason.
The status of the queue.
ACTIVE\u2013The queue is active.
SCHEDULING\u2013The queue is scheduling.
SCHEDULING_BLOCKED\u2013The queue scheduling is blocked. See the provided reason.
The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.
" + "smithy.api#documentation": "The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
" } }, "progressMessage": { @@ -9495,7 +9507,7 @@ "acquiredLimits": { "target": "com.amazonaws.deadline#AcquiredLimits", "traits": { - "smithy.api#documentation": "The limits and their amounts acquired during a session action. If no limits were\n acquired during the session, this field isn't returned.
" + "smithy.api#documentation": "The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
" } } }, @@ -9662,7 +9674,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Gets a set of statistics for queues or farms. Before you can call the\n GetSessionStatisticsAggregation operation, you must first call the\n StartSessionsStatisticsAggregation operation. Statistics are available for\n 1 hour after you call the StartSessionsStatisticsAggregation operation.
Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
The identifier of the farm to include in the statistics. This should be the same as the\n farm ID used in the call to the StartSessionsStatisticsAggregation\n operation.
The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.
The identifier returned by the StartSessionsStatisticsAggregation operation\n that identifies the aggregated statistics.
The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
The status of the aggregated results. An aggregation may fail or time out if the results\n are too large. If this happens, you can call the\n StartSessionsStatisticsAggregation operation after you reduce the\n aggregation time frame, reduce the number of queues or fleets in the aggregation, or\n increase the period length.
If you call the StartSessionsStatisticsAggregation operation when the\n status is IN_PROGRESS, you will receive a\n ThrottlingException.
The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.
If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.
The description of the step.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the step.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the storage profile connected to a queue.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the storage profile connected to a queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the storage profile.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the storage profile.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.
The default is 300 seconds (5 minutes).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string (\"\").
Specifies whether the job should run using the queue's system user or if the job should\n run using the worker agent system user.
", + "smithy.api#documentation": "Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
", "smithy.api#required": {} } } @@ -11423,7 +11476,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "The task run status for the job.
\n\n PENDING\u2013pending and waiting for resources.
\n READY\u2013ready to be processed.
\n ASSIGNED\u2013assigned and will run next on a worker.
\n SCHEDULED\u2013scheduled to be run on a worker.
\n INTERRUPTING\u2013being interrupted.
\n RUNNING\u2013running on a worker.
\n SUSPENDED\u2013the task is suspended.
\n CANCELED\u2013the task has been canceled.
\n FAILED\u2013the task has failed.
\n SUCCEEDED\u2013the task has succeeded.
The task run status for the job.
PENDING\u2013pending and waiting for resources.
READY\u2013ready to be processed.
ASSIGNED\u2013assigned and will run next on a worker.
SCHEDULED\u2013scheduled to be run on a worker.
INTERRUPTING\u2013being interrupted.
RUNNING\u2013running on a worker.
SUSPENDED\u2013the task is suspended.
CANCELED\u2013the task has been canceled.
FAILED\u2013the task has failed.
SUCCEEDED\u2013the task has succeeded.
The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The task run status for the job.
\n\n PENDING\u2013pending and waiting for resources.
\n READY\u2013ready to be processed.
\n ASSIGNED\u2013assigned and will run next on a worker.
\n SCHEDULED\u2013scheduled to be run on a worker.
\n INTERRUPTING\u2013being interrupted.
\n RUNNING\u2013running on a worker.
\n SUSPENDED\u2013the task is suspended.
\n CANCELED\u2013the task has been canceled.
\n FAILED\u2013the task has failed.
\n SUCCEEDED\u2013the task has succeeded.
The task run status for the job.
PENDING\u2013pending and waiting for resources.
READY\u2013ready to be processed.
ASSIGNED\u2013assigned and will run next on a worker.
SCHEDULED\u2013scheduled to be run on a worker.
INTERRUPTING\u2013being interrupted.
RUNNING\u2013running on a worker.
SUSPENDED\u2013the task is suspended.
CANCELED\u2013the task has been canceled.
FAILED\u2013the task has failed.
SUCCEEDED\u2013the task has succeeded.
The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The name of the limit used in lists to identify the limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe name of the limit used in lists to identify the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.
\nThe maxValue must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
The number of resources from the limit that are being used by jobs. The result is\n delayed and may not be the count at the time that you called the operation.
", + "smithy.api#documentation": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
", "smithy.api#required": {} } } @@ -12508,7 +12561,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display names of a list of fleets.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display names of a list of fleets.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
A list of MonitorSummary objects that describe your monitors in the\n Deadline Cloud.
A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
Specifies that the operation should return only the queue limit associations for the\n specified queue. If you specify both the queueId and the limitId,\n only the specified limit is returned if it exists.
Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
Specifies that the operation should return only the queue limit associations for the\n specified limit. If you specify both the queueId and the limitId,\n only the specified limit is returned if it exists.
Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
A list of associations between limits and queues in the farm specified in the\n request.
", + "smithy.api#documentation": "A list of associations between limits and queues in the farm specified in the request.
", "smithy.api#required": {} } }, @@ -13855,7 +13908,7 @@ "status": { "target": "com.amazonaws.deadline#QueueStatus", "traits": { - "smithy.api#documentation": "The status of the queues listed.
\n\n ACTIVE\u2013The queues are active.
\n SCHEDULING\u2013The queues are scheduling.
\n SCHEDULING_BLOCKED\u2013The queue scheduling is blocked for these\n queues.
The status of the queues listed.
ACTIVE\u2013The queues are active.
SCHEDULING\u2013The queues are scheduling.
SCHEDULING_BLOCKED\u2013The queue scheduling is blocked for these queues.
The name of the monitor that displays on the Deadline Cloud console.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe name of the monitor that displays on the Deadline Cloud console.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The subdomain used for the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.
", + "smithy.api#documentation": "The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.deadline#Url", "traits": { - "smithy.api#documentation": "The complete URL of the monitor. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.
", + "smithy.api#documentation": "The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to\n access Deadline Cloud resources.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
", "smithy.api#required": {} } }, @@ -16172,7 +16225,7 @@ "status": { "target": "com.amazonaws.deadline#QueueFleetAssociationStatus", "traits": { - "smithy.api#documentation": "The status of task scheduling in the queue-fleet association.
\n\n ACTIVE\u2013Association is active.
\n STOP_SCHEDULING_AND_COMPLETE_TASKS\u2013Association has stopped\n scheduling new tasks and is completing current tasks.
\n STOP_SCHEDULING_AND_CANCEL_TASKS\u2013Association has stopped\n scheduling new tasks and is canceling current tasks.
\n STOPPED\u2013Association has been stopped.
The status of task scheduling in the queue-fleet association.
ACTIVE\u2013Association is active.
STOP_SCHEDULING_AND_COMPLETE_TASKS\u2013Association has stopped scheduling new tasks and is completing current tasks.
STOP_SCHEDULING_AND_CANCEL_TASKS\u2013Association has stopped scheduling new tasks and is canceling current tasks.
STOPPED\u2013Association has been stopped.
The status of task scheduling in the queue-limit association.
\n\n ACTIVE - Association is active.
\n STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped\n scheduling new tasks and is completing current tasks.
\n STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped\n scheduling new tasks and is canceling current tasks.
\n STOPPED - Association has been stopped.
The status of task scheduling in the queue-limit association.
ACTIVE - Association is active.
STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks.
STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks.
STOPPED - Association has been stopped.
The display name of the queue summary to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the queue summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The budget action description.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe budget action description.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
Specifies how Deadline Cloud matches your search term in the results. If you don't\n specify a matchType the default is FUZZY_MATCH.
\n FUZZY_MATCH - Matches if a portion of the search term is found in the\n result.
\n CONTAINS - Matches if the exact search term is contained in the\n result.
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
Describes the GPU accelerator capabilities required for worker host instances in this\n fleet.
" + "smithy.api#documentation": "Describes the GPU accelerator capabilities required for worker host instances in this fleet.
" } }, "allowedInstanceTypes": { @@ -17645,7 +17698,7 @@ } }, "traits": { - "smithy.api#documentation": "You exceeded your service quota. Service quotas, also referred to as limits, are the\n maximum number of service resources or operations for your Amazon Web Services account.
", + "smithy.api#documentation": "You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -17664,6 +17717,12 @@ "traits": { "smithy.api#enumValue": "KMS_KEY_LIMIT_EXCEEDED" } + }, + "DEPENDENCY_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_LIMIT_EXCEEDED" + } } } }, @@ -17877,7 +17936,7 @@ "workerUpdatedAt": { "target": "com.amazonaws.deadline#Timestamp", "traits": { - "smithy.api#documentation": "The Linux timestamp of the last date and time that the session action was\n updated.
" + "smithy.api#documentation": "The Linux timestamp of the last date and time that the session action was updated.
" } }, "progressPercent": { @@ -18064,7 +18123,7 @@ "queueIds": { "target": "com.amazonaws.deadline#QueueIds", "traits": { - "smithy.api#documentation": "One to 10 queue IDs that specify the queues to return statistics for. If you specify the\n queueIds field, you can't specify the fleetIds field.
One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can't specify the fleetIds field.
One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the\n fleetIds field, you can't specify the queueIds field.
One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the fleetIds field, you can't specify the queueIds field.
Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet\n IDs or queue IDS, not both.
" + "smithy.api#documentation": "Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.
" } }, "com.amazonaws.deadline#SortOrder": { @@ -18136,7 +18195,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Starts an asynchronous request for getting aggregated statistics about queues and farms.\n Get the statistics using the GetSessionsStatisticsAggregation operation. You\n can only have one running aggregation for your Deadline Cloud farm. Call the\n GetSessionsStatisticsAggregation operation and check the\n status field to see if an aggregation is running. Statistics are available\n for 1 hour after you call the StartSessionsStatisticsAggregation\n operation.
Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
The identifier of the farm that contains queues or fleets to return statistics\n for.
", + "smithy.api#documentation": "The identifier of the farm that contains queues or fleets to return statistics for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18219,7 +18278,7 @@ "aggregationId": { "target": "com.amazonaws.deadline#AggregationId", "traits": { - "smithy.api#documentation": "A unique identifier for the aggregated statistics. Use this identifier with the\n GetAggregatedStatisticsForSessions operation to return the\n statistics.
A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.
How the statistics should appear in USD. Options include: minimum, maximum, average or\n sum.
", + "smithy.api#documentation": "How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
", "smithy.api#required": {} } }, @@ -18809,7 +18868,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "The task run status for the job.
\n\n PENDING\u2013pending and waiting for resources.
\n READY\u2013ready to be processed.
\n ASSIGNED\u2013assigned and will run next on a worker.
\n SCHEDULED\u2013scheduled to be run on a worker.
\n INTERRUPTING\u2013being interrupted.
\n RUNNING\u2013running on a worker.
\n SUSPENDED\u2013the task is suspended.
\n CANCELED\u2013the task has been canceled.
\n FAILED\u2013the task has failed.
\n SUCCEEDED\u2013the task has succeeded.
The task run status for the job.
PENDING\u2013pending and waiting for resources.
READY\u2013ready to be processed.
ASSIGNED\u2013assigned and will run next on a worker.
SCHEDULED\u2013scheduled to be run on a worker.
INTERRUPTING\u2013being interrupted.
RUNNING\u2013running on a worker.
SUSPENDED\u2013the task is suspended.
CANCELED\u2013the task has been canceled.
FAILED\u2013the task has failed.
SUCCEEDED\u2013the task has succeeded.
The task run status for the job.
\n\n PENDING\u2013pending and waiting for resources.
\n READY\u2013ready to process.
\n ASSIGNED\u2013assigned and will run next on a worker.
\n SCHEDULED\u2013scheduled to run on a worker.
\n INTERRUPTING\u2013being interrupted.
\n RUNNING\u2013running on a worker.
\n SUSPENDED\u2013the task is suspended.
\n CANCELED\u2013the task has been canceled.
\n FAILED\u2013the task has failed.
\n SUCCEEDED\u2013the task has succeeded.
The task run status for the job.
PENDING\u2013pending and waiting for resources.
READY\u2013ready to process.
ASSIGNED\u2013assigned and will run next on a worker.
SCHEDULED\u2013scheduled to run on a worker.
INTERRUPTING\u2013being interrupted.
RUNNING\u2013running on a worker.
SUSPENDED\u2013the task is suspended.
CANCELED\u2013the task has been canceled.
FAILED\u2013the task has failed.
SUCCEEDED\u2013the task has succeeded.
The display name of the storage profile summary to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the storage profile summary to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the budget to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the budget to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the budget to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the budget to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Updates the status of the budget.
\n\n ACTIVE\u2013The budget is being evaluated.
\n INACTIVE\u2013The budget is inactive. This can include Expired,\n Canceled, or deleted Deleted statuses.
Updates the status of the budget.
ACTIVE\u2013The budget is being evaluated.
INACTIVE\u2013The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
The budget actions to add. Budget actions specify what happens when the budget runs\n out.
" + "smithy.api#documentation": "The budget actions to add. Budget actions specify what happens when the budget runs out.
" } }, "actionsToRemove": { @@ -20086,13 +20145,13 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the farm to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the farm to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the farm to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the farm to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The display name of the fleet to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the fleet to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the fleet to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the fleet to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The maximum number of workers in the fleet.
" + "smithy.api#documentation": "The maximum number of workers in the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The fleet configuration to update.
" } + }, + "hostConfiguration": { + "target": "com.amazonaws.deadline#HostConfiguration", + "traits": { + "smithy.api#documentation": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + } } }, "traits": { @@ -20267,7 +20332,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "Updates a job.
\nWhen you change the status of the job to ARCHIVED, the job can't be\n scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be\n recovered.
\nUpdates a job.
When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
The status of a job in its lifecycle. When you change the status of the job to\n ARCHIVED, the job can't be scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be\n recovered.
\nThe status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of workers that can process tasks in the job.
" + "smithy.api#documentation": "The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of workers that can process tasks in the job.
" } }, "farmId": { @@ -20440,19 +20505,19 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The new display name of the limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe new display name of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The new description of the limit.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe new description of the limit.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.
\nIf more than the new maximum number is currently in use, running jobs finish but no new\n jobs are started until the number of resources in use is below the new maximum\n number.
\nThe maxCount must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings\n when you call UpdateMonitor.
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
The new value to use for the monitor's display name.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe new value to use for the monitor's display name.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Updates the status of the queue. If you set the status to one of the\n STOP_LIMIT_USAGE* values, there will be a delay before the status\n transitions to the STOPPED state.
Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
Sets the status of the limit. You can mark the limit active, or you can stop usage of\n the limit and either complete existing tasks or cancel any existing tasks immediately.\n
", + "smithy.api#documentation": "Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.
", "smithy.api#required": {} } } @@ -20985,13 +21050,13 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the queue to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the queue to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The description of the queue to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe description of the queue to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The job attachment settings to update for the\n queue.
" + "smithy.api#documentation": "The job attachment settings to update for the queue.
" } }, "roleArn": { @@ -21348,7 +21413,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "The display name of the storage profile to update.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe display name of the storage profile to update.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The worker log to update.
" } + }, + "hostConfiguration": { + "target": "com.amazonaws.deadline#HostConfiguration", + "traits": { + "smithy.api#documentation": "The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + } } }, "traits": { @@ -21761,7 +21832,7 @@ "processExitCode": { "target": "com.amazonaws.deadline#ProcessExitCode", "traits": { - "smithy.api#documentation": "The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.
" + "smithy.api#documentation": "The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
" } }, "progressMessage": { @@ -21799,7 +21870,7 @@ } }, "traits": { - "smithy.api#documentation": "The updated session action information as it relates to completion and progress of the\n session.
" + "smithy.api#documentation": "The updated session action information as it relates to completion and progress of the session.
" } }, "com.amazonaws.deadline#UpdatedSessionActions": { @@ -22039,7 +22110,7 @@ } }, "traits": { - "smithy.api#documentation": "The request isn't valid. This can occur if your request contains malformed JSON or\n unsupported characters.
", + "smithy.api#documentation": "The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/models/dsql/service/2018-05-10/dsql-2018-05-10.json b/models/dsql/service/2018-05-10/dsql-2018-05-10.json index ef698753..38e45cbe 100644 --- a/models/dsql/service/2018-05-10/dsql-2018-05-10.json +++ b/models/dsql/service/2018-05-10/dsql-2018-05-10.json @@ -20,7 +20,7 @@ "com.amazonaws.dsql#Arn": { "type": "string", "traits": { - "smithy.api#documentation": "Amazon Resource Name", + "smithy.api#documentation": "Amazon Resource Name.
", "smithy.api#length": { "min": 1, "max": 1011 @@ -31,7 +31,7 @@ "com.amazonaws.dsql#ClientToken": { "type": "string", "traits": { - "smithy.api#documentation": "Idempotency Token", + "smithy.api#documentation": "Idempotency token so a request is only processed once.
", "smithy.api#length": { "min": 1, "max": 128 @@ -80,14 +80,6 @@ "target": "com.amazonaws.dsql#GetVpcEndpointServiceName" } ], - "collectionOperations": [ - { - "target": "com.amazonaws.dsql#CreateMultiRegionClusters" - }, - { - "target": "com.amazonaws.dsql#DeleteMultiRegionClusters" - } - ], "traits": { "aws.api#arn": { "template": "cluster/{identifier}" @@ -101,7 +93,8 @@ "service": "com.amazonaws.dsql#DSQL", "resource": "com.amazonaws.dsql#Cluster" }, - "smithy.api#documentation": "Cluster ARN" + "smithy.api#documentation": "The Amazon Resource Name of the cluster.
", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}$" } }, "com.amazonaws.dsql#ClusterArnList": { @@ -110,20 +103,20 @@ "target": "com.amazonaws.dsql#ClusterArn" }, "traits": { - "smithy.api#documentation": "List of cluster arns", + "smithy.api#documentation": "A list of the Amazon Resource Names of the cluster.
", "smithy.api#uniqueItems": {} } }, "com.amazonaws.dsql#ClusterCreationTime": { "type": "timestamp", "traits": { - "smithy.api#documentation": "Timestamp when the Cluster was created" + "smithy.api#documentation": "The timestamp when the cluster was created.
" } }, "com.amazonaws.dsql#ClusterId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID of the cluster", + "smithy.api#documentation": "The ID of the cluster.
", "smithy.api#pattern": "^[a-z0-9]{26}$" } }, @@ -133,22 +126,10 @@ "target": "com.amazonaws.dsql#ClusterSummary" }, "traits": { - "smithy.api#documentation": "List of clusters", + "smithy.api#documentation": "The list of clusters.
", "smithy.api#uniqueItems": {} } }, - "com.amazonaws.dsql#ClusterPropertyMap": { - "type": "map", - "key": { - "target": "com.amazonaws.dsql#Region" - }, - "value": { - "target": "com.amazonaws.dsql#LinkedClusterProperties" - }, - "traits": { - "smithy.api#documentation": "Properties for each linked cluster" - } - }, "com.amazonaws.dsql#ClusterStatus": { "type": "enum", "members": { @@ -164,6 +145,18 @@ "smithy.api#enumValue": "ACTIVE" } }, + "IDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDLE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, "UPDATING": { "target": "smithy.api#Unit", "traits": { @@ -187,10 +180,22 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "PENDING_SETUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_SETUP" + } + }, + "PENDING_DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETE" + } } }, "traits": { - "smithy.api#documentation": "Cluster Status" + "smithy.api#documentation": "The current status of a cluster.
" } }, "com.amazonaws.dsql#ClusterSummary": { @@ -257,13 +262,16 @@ }, { "target": "com.amazonaws.dsql#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create new clusters." }, - "smithy.api#documentation": "Creates a cluster in Amazon Aurora DSQL.
", + "smithy.api#documentation": "The CreateCluster API allows you to create both single-region clusters and multi-Region\n clusters. With the addition of the multiRegionProperties parameter,\n you can create a cluster with witness Region support and establish peer relationships with\n clusters in other Regions during creation.
\nCreating multi-Region clusters requires additional IAM permissions beyond those\n needed for single-Region clusters, as detailed in the Required permissions section\n below.
\n\n Required permissions\n
\nRequired to create a cluster.
\nResources: arn:aws:dsql:region:account-id:cluster/*\n
Permission to add tags to a resource.
\nResources: arn:aws:dsql:region:account-id:cluster/*\n
Permission to configure multi-region properties for a cluster.
\nResources: arn:aws:dsql:region:account-id:cluster/*\n
When specifying multiRegionProperties.clusters, permission to\n add peer clusters.
Resources:
\nLocal cluster: arn:aws:dsql:region:account-id:cluster/*\n
Each peer cluster: exact ARN of each specified peer cluster
\nWhen specifying multiRegionProperties.witnessRegion, permission\n to set a witness Region. This permission is checked both in the cluster Region and\n in the witness Region.
Resources: arn:aws:dsql:region:account-id:cluster/*\n
Condition Keys: dsql:WitnessRegion (matching the specified witness region)
The witness Region specified in\n multiRegionProperties.witnessRegion cannot be the same as the\n cluster's Region.
If enabled, you can't delete your cluster. You must first\n disable this property before you can delete your cluster.
" + "smithy.api#documentation": "If enabled, you can't delete your cluster. You must first disable this property before\n you can delete your cluster.
" } }, "tags": { @@ -302,9 +310,16 @@ "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully, the subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, the subsequent retries with the\n same client token return the result from the original successful request and they have no\n additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK automatically generates\n one.
", "smithy.api#idempotencyToken": {} } + }, + "multiRegionProperties": { + "target": "com.amazonaws.dsql#MultiRegionProperties", + "traits": { + "smithy.api#documentation": "The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -342,117 +357,23 @@ "smithy.api#required": {} } }, - "deletionProtectionEnabled": { - "target": "com.amazonaws.dsql#DeletionProtectionEnabled", + "multiRegionProperties": { + "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { - "smithy.api#documentation": "Whether deletion protection is enabled on this cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Output Mixin", - "smithy.api#output": {} - } - }, - "com.amazonaws.dsql#CreateMultiRegionClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.dsql#CreateMultiRegionClustersInput" - }, - "output": { - "target": "com.amazonaws.dsql#CreateMultiRegionClustersOutput" - }, - "errors": [ - { - "target": "com.amazonaws.dsql#ConflictException" - }, - { - "target": "com.amazonaws.dsql#ServiceQuotaExceededException" - } - ], - "traits": { - "aws.iam#iamAction": { - "documentation": "Grants permission to create multi-Region clusters. This action requires the CreateMultiRegionClusters and CreateCluster permissions in each specified linked Region.", - "requiredActions": [ - "dsql:CreateCluster" - ] - }, - "smithy.api#documentation": "Creates multi-Region clusters in Amazon Aurora DSQL. \n Multi-Region clusters require a linked Region list, which is an array\n of the Regions in which you want to create linked clusters.\n Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
", - "smithy.api#examples": [ - { - "title": "Create Multi Region Clusters", - "input": { - "linkedRegionList": [ - "us-east-1", - "us-east-2" - ], - "witnessRegion": "us-west-2" - }, - "output": { - "linkedClusterArns": [ - "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", - "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/multi-region-clusters" - } - } - }, - "com.amazonaws.dsql#CreateMultiRegionClustersInput": { - "type": "structure", - "members": { - "linkedRegionList": { - "target": "com.amazonaws.dsql#RegionList", - "traits": { - "smithy.api#documentation": "An array of the Regions in which you want to create additional clusters.
", - "smithy.api#notProperty": {}, - "smithy.api#required": {} - } - }, - "clusterProperties": { - "target": "com.amazonaws.dsql#ClusterPropertyMap", - "traits": { - "smithy.api#documentation": "A mapping of properties to use when creating linked clusters.
", + "smithy.api#documentation": "The multi-Region cluster configuration details that were set during cluster creation
", "smithy.api#notProperty": {} } }, - "witnessRegion": { - "target": "com.amazonaws.dsql#Region", - "traits": { - "smithy.api#documentation": "The witness Region of multi-Region clusters.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.dsql#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.dsql#CreateMultiRegionClustersOutput": { - "type": "structure", - "members": { - "linkedClusterArns": { - "target": "com.amazonaws.dsql#ClusterArnList", + "deletionProtectionEnabled": { + "target": "com.amazonaws.dsql#DeletionProtectionEnabled", "traits": { - "smithy.api#documentation": "An array that contains the ARNs of all linked clusters.
", + "smithy.api#documentation": "Whether deletion protection is enabled on this cluster.
", "smithy.api#required": {} } } }, "traits": { + "smithy.api#documentation": "The output of a created cluster.
", "smithy.api#output": {} } }, @@ -503,7 +424,7 @@ "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "This is an interface reference for Amazon Aurora DSQL.\n It contains documentation for one of the programming or\n command line interfaces you can use to manage Amazon Aurora DSQL.
\nAmazon Aurora DSQL is a serverless, distributed SQL\n database suitable for workloads of any size. Aurora DSQL\n is available in both single-Region and multi-Region configurations,\n so your clusters and databases are always available even if an\n Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL\n lets you focus on using your data to acquire new insights for your\n business and customers.
", + "smithy.api#documentation": "This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the\n programming or command line interfaces you can use to manage Amazon Aurora DSQL.
\nAmazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.\n is available in both single-Region and multi-Region configurations, so your\n clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to\n acquire new insights for your business and customers.
", "smithy.api#title": "Amazon Aurora DSQL", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -896,7 +817,7 @@ "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully. The subsequent retries with the\n same client token return the result from the original successful request and they have no\n additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK automatically generates\n one.
", "smithy.api#httpQuery": "client-token", "smithy.api#idempotencyToken": {} } @@ -936,91 +857,17 @@ "smithy.api#documentation": "The time of when the cluster was created.
", "smithy.api#required": {} } - }, - "deletionProtectionEnabled": { - "target": "com.amazonaws.dsql#DeletionProtectionEnabled", - "traits": { - "smithy.api#documentation": "Specifies whether deletion protection was enabled on the cluster.
", - "smithy.api#required": {} - } } }, "traits": { - "smithy.api#documentation": "Output Mixin", + "smithy.api#documentation": "The output from a deleted cluster.
", "smithy.api#output": {} } }, - "com.amazonaws.dsql#DeleteMultiRegionClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.dsql#DeleteMultiRegionClustersInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.dsql#ConflictException" - }, - { - "target": "com.amazonaws.dsql#ResourceNotFoundException" - } - ], - "traits": { - "aws.iam#iamAction": { - "documentation": "Grants permission to delete multi-Region clusters. This action requires the DeleteMultiRegionClusters and DeleteCluster permissions in each specified linked Region.", - "requiredActions": [ - "dsql:DeleteCluster" - ] - }, - "smithy.api#documentation": "Deletes a multi-Region cluster in Amazon Aurora DSQL.
", - "smithy.api#examples": [ - { - "title": "Delete Multi Region Clusters", - "input": { - "linkedClusterArns": [ - "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", - "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/multi-region-clusters" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.dsql#DeleteMultiRegionClustersInput": { - "type": "structure", - "members": { - "linkedClusterArns": { - "target": "com.amazonaws.dsql#ClusterArnList", - "traits": { - "smithy.api#documentation": "The ARNs of the clusters linked to the cluster you want to delete. \n also deletes these clusters as part of the operation.
", - "smithy.api#httpQuery": "linked-cluster-arns", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.dsql#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.
", - "smithy.api#httpQuery": "client-token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, "com.amazonaws.dsql#DeletionProtectionEnabled": { "type": "boolean", "traits": { - "smithy.api#documentation": "Deletion Protection" + "smithy.api#documentation": "Indicates whether deletion protection is enabled for a cluster.
" } }, "com.amazonaws.dsql#GetCluster": { @@ -1156,23 +1003,22 @@ "smithy.api#required": {} } }, - "witnessRegion": { - "target": "com.amazonaws.dsql#Region", + "multiRegionProperties": { + "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { - "smithy.api#documentation": "The witness Region of the cluster. Applicable only for \n multi-Region clusters.
", + "smithy.api#documentation": "Returns the current multi-Region cluster configuration, including witness region and linked cluster information.
", "smithy.api#notProperty": {} } }, - "linkedClusterArns": { - "target": "com.amazonaws.dsql#ClusterArnList", + "tags": { + "target": "com.amazonaws.dsql#TagMap", "traits": { - "smithy.api#documentation": "The ARNs of the clusters linked to the retrieved cluster.
", "smithy.api#notProperty": {} } } }, "traits": { - "smithy.api#documentation": "Output Mixin", + "smithy.api#documentation": "The output of a cluster.
", "smithy.api#output": {} } }, @@ -1286,33 +1132,12 @@ } }, "traits": { - "smithy.api#documentation": "The request processing has failed because of an unknown error, \n exception or failure.
", + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, - "com.amazonaws.dsql#LinkedClusterProperties": { - "type": "structure", - "members": { - "deletionProtectionEnabled": { - "target": "com.amazonaws.dsql#DeletionProtectionEnabled", - "traits": { - "smithy.api#default": true, - "smithy.api#documentation": "Whether deletion protection is enabled.
" - } - }, - "tags": { - "target": "com.amazonaws.dsql#TagMap", - "traits": { - "smithy.api#documentation": "A map of key and value pairs the linked cluster is tagged with.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Properties of linked clusters.
" - } - }, "com.amazonaws.dsql#ListClusters": { "type": "operation", "input": { @@ -1373,14 +1198,14 @@ "target": "com.amazonaws.dsql#MaxResults", "traits": { "smithy.api#default": 20, - "smithy.api#documentation": "An optional parameter that specifies the maximum number of results to return. \n You can use nextToken to display the next page of results.
", + "smithy.api#documentation": "An optional parameter that specifies the maximum number of results to return. You can\n use nextToken to display the next page of results.
", "smithy.api#httpQuery": "max-results" } }, "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { - "smithy.api#documentation": "If your initial ListClusters operation returns a nextToken,\n you can include the returned nextToken in following ListClusters operations, \n which returns results in the next page.
", + "smithy.api#documentation": "If your initial ListClusters operation returns a nextToken, you can include the returned\n nextToken in following ListClusters operations, which returns results in the next\n page.
", "smithy.api#httpQuery": "next-token" } } @@ -1395,7 +1220,7 @@ "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { - "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of \n nextToken is a unique pagination token for each page. To retrieve the \n next page, make the call again using the returned token.
" + "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a\n unique pagination token for each page. To retrieve the next page, make the call again using\n the returned token.
" } }, "clusters": { @@ -1476,38 +1301,48 @@ "com.amazonaws.dsql#MaxResults": { "type": "integer", "traits": { - "smithy.api#documentation": "Max results that will be returned per page", + "smithy.api#documentation": "Max results that will be returned per page.
", "smithy.api#range": { "min": 1, "max": 100 } } }, + "com.amazonaws.dsql#MultiRegionProperties": { + "type": "structure", + "members": { + "witnessRegion": { + "target": "com.amazonaws.dsql#Region", + "traits": { + "smithy.api#documentation": "The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.
" + } + }, + "clusters": { + "target": "com.amazonaws.dsql#ClusterArnList", + "traits": { + "smithy.api#documentation": "The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.
" + } + }, "com.amazonaws.dsql#NextToken": { "type": "string", "traits": { - "smithy.api#documentation": "Opaque token used to retrieve next page" + "smithy.api#documentation": "Token used to retrieve next page.
" } }, "com.amazonaws.dsql#Region": { "type": "string", "traits": { - "smithy.api#documentation": "AWS Region name (e.g.: 'us-east-1')", + "smithy.api#documentation": "Region name.
", "smithy.api#length": { - "max": 20 + "max": 50 } } }, - "com.amazonaws.dsql#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.dsql#Region" - }, - "traits": { - "smithy.api#documentation": "List of regions", - "smithy.api#uniqueItems": {} - } - }, "com.amazonaws.dsql#ResourceNotFoundException": { "type": "structure", "members": { @@ -1520,14 +1355,14 @@ "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Hypothetical identifier of the resource which does not exist", + "smithy.api#documentation": "The resource ID could not be found.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Hypothetical type of the resource which does not exist", + "smithy.api#documentation": "The resource type could not be found.
", "smithy.api#required": {} } } @@ -1541,7 +1376,7 @@ "com.amazonaws.dsql#ServiceName": { "type": "string", "traits": { - "smithy.api#documentation": "VPC Endpoint Service name for a Cluster", + "smithy.api#documentation": "The name of the VPC endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.
", "smithy.api#length": { "min": 1, "max": 128 @@ -1555,35 +1390,35 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error", + "smithy.api#documentation": "The service exception for exceeding a quota.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected", + "smithy.api#documentation": "The resource ID exceeds a quota.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected", + "smithy.api#documentation": "The resource type exceeds a quota.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service", + "smithy.api#documentation": "The request exceeds a service quota.
", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota", + "smithy.api#documentation": "The service exceeds a quota.
", "smithy.api#required": {} } } @@ -1597,7 +1432,7 @@ "com.amazonaws.dsql#TagKey": { "type": "string", "traits": { - "smithy.api#documentation": "Unique tag key, maximum 128 Unicode characters in UTF-8", + "smithy.api#documentation": "Unique tag key, maximum 128 Unicode characters in UTF-8.
", "smithy.api#length": { "min": 1, "max": 128 @@ -1611,7 +1446,7 @@ "target": "com.amazonaws.dsql#TagKey" }, "traits": { - "smithy.api#documentation": "List of tag keys", + "smithy.api#documentation": "List of tag keys.
", "smithy.api#length": { "min": 0, "max": 200 @@ -1627,7 +1462,7 @@ "target": "com.amazonaws.dsql#TagValue" }, "traits": { - "smithy.api#documentation": "Map of tags", + "smithy.api#documentation": "Map of tags.
", "smithy.api#length": { "min": 0, "max": 200 @@ -1699,7 +1534,7 @@ "com.amazonaws.dsql#TagValue": { "type": "string", "traits": { - "smithy.api#documentation": "Tag value, maximum 256 Unicode characters in UTF-8", + "smithy.api#documentation": "Tag value, maximum 256 Unicode characters in UTF-8.
", "smithy.api#length": { "min": 0, "max": 256 @@ -1713,26 +1548,26 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error", + "smithy.api#documentation": "The message that the request was denied due to request throttling.
", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service" + "smithy.api#documentation": "The request exceeds a service quota.
" } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota" + "smithy.api#documentation": "The request exceeds a request rate quota.
" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried", + "smithy.api#documentation": "The request exceeds a request rate quota. Retry after seconds.
", "smithy.api#httpHeader": "Retry-After" } } @@ -1821,13 +1656,16 @@ }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to modify the deletion protection status of a given cluster." }, - "smithy.api#documentation": "Updates a cluster.
", + "smithy.api#documentation": "The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.
\nNote that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.
\n\n Required permissions\n
\nPermission to update a DSQL cluster.
\nResources: arn:aws:dsql:region:account-id:cluster/cluster-id\n \n
Permission to configure multi-Region properties for a cluster.
\nResources: arn:aws:dsql:region:account-id:cluster/cluster-id\n \n
Permission to retrieve cluster information.
\nResources: arn:aws:dsql:region:account-id:cluster/cluster-id\n \n
Permission to add peer clusters.
\nResources:
\nLocal cluster: arn:aws:dsql:region:account-id:cluster/cluster-id\n \n
Each peer cluster: exact ARN of each specified peer cluster
\nPermission to remove peer clusters. The dsql:RemovePeerCluster permission\n uses a wildcard ARN pattern to simplify permission management during updates.
\nResources:\n arn:aws:dsql:*:account-id:cluster/*\n
Permission to set a witness Region.
\nResources: arn:aws:dsql:region:account-id:cluster/cluster-id\n \n
Condition Keys: dsql:WitnessRegion (matching the specified witness\n Region)
\n\n This permission is checked both in the cluster Region and in the witness\n Region.\n
\nThe witness region specified in\n multiRegionProperties.witnessRegion cannot be the same as the\n cluster's Region.
When updating clusters with peer relationships, permissions are checked for both adding and removing peers.
\nThe dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
A unique, case-sensitive identifier that you provide to ensure the \n idempotency of the request. Idempotency ensures that an API request completes\n only once. With an idempotent request, if the original request completes \n successfully. The subsequent retries with the same client token return the \n result from the original successful request and they \n have no additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK \n automatically generates one.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully. The subsequent retries with the\n same client token return the result from the original successful request and they have no\n additional effect.
\nIf you don't specify a client token, the Amazon Web Services SDK automatically generates\n one.
", "smithy.api#idempotencyToken": {} } + }, + "multiRegionProperties": { + "target": "com.amazonaws.dsql#MultiRegionProperties", + "traits": { + "smithy.api#documentation": "The new multi-Region cluster configuration settings to be applied during an update operation.
", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -1903,31 +1748,10 @@ "smithy.api#documentation": "The time of when the cluster was created.
", "smithy.api#required": {} } - }, - "deletionProtectionEnabled": { - "target": "com.amazonaws.dsql#DeletionProtectionEnabled", - "traits": { - "smithy.api#documentation": "Whether deletion protection is enabled for the updated cluster.
", - "smithy.api#required": {} - } - }, - "witnessRegion": { - "target": "com.amazonaws.dsql#Region", - "traits": { - "smithy.api#documentation": "The Region that receives all data you write to linked clusters.
", - "smithy.api#notProperty": {} - } - }, - "linkedClusterArns": { - "target": "com.amazonaws.dsql#ClusterArnList", - "traits": { - "smithy.api#documentation": "The ARNs of the clusters linked to the updated cluster. Applicable\n only for multi-Region clusters.
", - "smithy.api#notProperty": {} - } } }, "traits": { - "smithy.api#documentation": "Output Mixin", + "smithy.api#documentation": "The details of the cluster after it has been updated.
", "smithy.api#output": {} } }, @@ -1943,11 +1767,15 @@ "reason": { "target": "com.amazonaws.dsql#ValidationExceptionReason", "traits": { + "smithy.api#documentation": "The reason for the validation exception.
", "smithy.api#required": {} } }, "fieldList": { - "target": "com.amazonaws.dsql#ValidationExceptionFieldList" + "target": "com.amazonaws.dsql#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of fields that didn't validate.
" + } } }, "traits": { @@ -1975,7 +1803,7 @@ } }, "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a \n request that resulted in an validation error.
" + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation\n error.
" } }, "com.amazonaws.dsql#ValidationExceptionFieldList": { @@ -1984,7 +1812,7 @@ "target": "com.amazonaws.dsql#ValidationExceptionField" }, "traits": { - "smithy.api#documentation": "List of fields that caused the error" + "smithy.api#documentation": "A list of fields that didn't validate.
" } }, "com.amazonaws.dsql#ValidationExceptionReason": { @@ -2022,7 +1850,7 @@ } }, "traits": { - "smithy.api#documentation": "Reason the request failed validation" + "smithy.api#documentation": "The reason for the validation exception.
" } } } diff --git a/models/ec2/service/2016-11-15/ec2-2016-11-15.json b/models/ec2/service/2016-11-15/ec2-2016-11-15.json index dcd4af9d..79f49f6a 100644 --- a/models/ec2/service/2016-11-15/ec2-2016-11-15.json +++ b/models/ec2/service/2016-11-15/ec2-2016-11-15.json @@ -404,14 +404,14 @@ "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
The IDs of the Convertible Reserved Instances to exchange for another Convertible\n Reserved Instance of the same or higher value.
", + "smithy.api#documentation": "The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved\n Instance of the same or higher value.
", "smithy.api#required": {}, "smithy.api#xmlName": "ReservedInstanceId" } @@ -419,7 +419,7 @@ "TargetConfigurations": { "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", "traits": { - "smithy.api#documentation": "The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.
", + "smithy.api#documentation": "The configuration of the target Convertible Reserved Instance to exchange for your current\n Convertible Reserved Instances.
", "smithy.api#xmlName": "TargetConfiguration" } } @@ -1832,6 +1832,12 @@ "smithy.api#xmlName": "AssetId" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The ID of the Availability Zone.
" + } + }, "AutoPlacement": { "target": "com.amazonaws.ec2#AutoPlacement", "traits": { @@ -1868,9 +1874,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Availability Zone in which to allocate the Dedicated Host.
", - "smithy.api#required": {}, "smithy.api#xmlName": "availabilityZone" } } @@ -2482,6 +2486,9 @@ { "target": "com.amazonaws.ec2#CreateDefaultVpc" }, + { + "target": "com.amazonaws.ec2#CreateDelegateMacVolumeOwnershipTask" + }, { "target": "com.amazonaws.ec2#CreateDhcpOptions" }, @@ -2554,6 +2561,9 @@ { "target": "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceGroup" }, + { + "target": "com.amazonaws.ec2#CreateMacSystemIntegrityProtectionModificationTask" + }, { "target": "com.amazonaws.ec2#CreateManagedPrefixList" }, @@ -3226,6 +3236,9 @@ { "target": "com.amazonaws.ec2#DescribeMacHosts" }, + { + "target": "com.amazonaws.ec2#DescribeMacModificationTasks" + }, { "target": "com.amazonaws.ec2#DescribeManagedPrefixLists" }, @@ -5571,6 +5584,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "Instance": { "target": "com.amazonaws.ec2#AnalysisComponent", "traits": { @@ -6208,7 +6229,7 @@ "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns the specified IPv6 addresses to the specified network interface. You can\n specify specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies by instance type.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Assigns the specified IPv6 addresses to the specified network interface. You can\n specify specific IPv6 addresses, or you can specify the number of IPv6 addresses to be\n automatically assigned from the subnet's IPv6 CIDR block range. You can assign as many\n IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the\n limit varies by instance type.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see Assigning prefixes to network\n interfaces in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -6241,7 +6262,7 @@ "target": "com.amazonaws.ec2#Ipv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", + "smithy.api#documentation": "The IPv6 addresses to be assigned to the network interface. You can't use this option\n if you're specifying a number of IPv6 addresses.
", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -6249,7 +6270,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.
", + "smithy.api#documentation": "The number of additional IPv6 addresses to assign to the network interface. The\n specified number of IPv6 addresses are assigned in addition to the existing IPv6\n addresses that are already assigned to the network interface. Amazon EC2 automatically\n selects the IPv6 addresses from the subnet range. You can't use this option if\n specifying specific IPv6 addresses.
", "smithy.api#xmlName": "ipv6AddressCount" } } @@ -6265,7 +6286,7 @@ "target": "com.amazonaws.ec2#Ipv6AddressList", "traits": { "aws.protocols#ec2QueryName": "AssignedIpv6Addresses", - "smithy.api#documentation": "The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses \n \tthat were assigned to the network interface before the request are not included.
", + "smithy.api#documentation": "The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that\n were assigned to the network interface before the request are not included.
", "smithy.api#xmlName": "assignedIpv6Addresses" } }, @@ -6299,7 +6320,7 @@ "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns the specified secondary private IP addresses to the specified network interface.
\nYou can specify specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Assigns the specified secondary private IP addresses to the specified network\n interface.
\nYou can specify specific secondary IP addresses, or you can specify the number of\n secondary IP addresses to be automatically assigned from the subnet's CIDR block range.\n The number of secondary IP addresses that you can assign to an instance varies by\n instance type. For more information about Elastic IP addresses, see Elastic IP\n Addresses in the Amazon EC2 User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic\n IP address that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from\n one network interface to another, check\n network/interfaces/macs/mac/local-ipv4s in the instance metadata to\n confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the\n request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see Assigning prefixes to network\n interfaces in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To assign a specific secondary private IP address to an interface", @@ -6352,7 +6373,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", + "smithy.api#documentation": "The IP addresses to be assigned as a secondary private IP address to the network\n interface. You can't specify this parameter when also specifying a number of secondary\n IP addresses.
\nIf you don't specify an IP address, Amazon EC2 automatically selects an IP address within\n the subnet range.
", "smithy.api#xmlName": "privateIpAddress" } }, @@ -6360,7 +6381,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
", + "smithy.api#documentation": "The number of secondary IP addresses to assign to the network interface. You can't\n specify this parameter when also specifying private IP addresses.
", "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, @@ -6368,7 +6389,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "AllowReassignment", - "smithy.api#documentation": "Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", + "smithy.api#documentation": "Indicates whether to allow an IP address that is already assigned to another network\n interface or instance to be reassigned to the specified network interface.
", "smithy.api#xmlName": "allowReassignment" } } @@ -8259,20 +8280,26 @@ "NetworkCardIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.
" + "smithy.api#documentation": "The index of the network card. Some instance types support multiple network cards. The\n primary network interface must be assigned to network card index 0. The default is\n network card index 0.
" } }, "EnaSrdSpecification": { "target": "com.amazonaws.ec2#EnaSrdSpecification", "traits": { - "smithy.api#documentation": "Configures ENA Express for the network interface that this action attaches to the instance.
" + "smithy.api#documentation": "Configures ENA Express for the network interface that this action attaches to the\n instance.
" + } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The number of ENA queues to be created with the instance.
" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Cancels the specified Reserved Instance listing in the Reserved Instance\n Marketplace.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CancelReservedInstancesListingRequest": { @@ -12315,6 +12342,14 @@ "smithy.api#documentation": "The tenancy of the Capacity Reservation.
", "smithy.api#xmlName": "tenancy" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } } }, "traits": { @@ -13759,7 +13794,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DisconnectOnSessionTimeout", - "smithy.api#documentation": "Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the idle\n timeout for connection tracking on an Elastic network interface. For more information,\n see Connection tracking timeouts in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecification": { @@ -14556,7 +14591,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the idle\n timeout for connection tracking on an Elastic network interface. For more information,\n see Connection tracking timeouts in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest": { @@ -14582,7 +14617,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification request that enables you to set the\n idle timeout for connection tracking on an Elastic network interface. For more\n information, see Connection tracking timeouts in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse": { @@ -14614,7 +14649,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification response that enables you to set\n the idle timeout for connection tracking on an Elastic network interface. For more\n information, see Connection tracking timeouts in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectivityType": { @@ -14943,7 +14978,7 @@ "SnapshotCopyCompletionDurationMinutes": { "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "Specify a completion duration, in 15 minute increments, to initiate a time-based \n AMI copy. The specified completion duration applies to each of the snapshots associated \n with the AMI. Each snapshot associated with the AMI will be completed within the \n specified completion duration, regardless of their size.
\nIf you do not specify a value, the AMI copy operation is completed on a best-effort \n basis.
\nFor more information, see \n Time-based copies.
" + "smithy.api#documentation": "Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy.\n The specified completion duration applies to each of the snapshots associated with the AMI.\n Each snapshot associated with the AMI will be completed within the specified completion\n duration, with copy throughput automatically adjusted for each snapshot based on its size to\n meet the timing target.
\nIf you do not specify a value, the AMI copy operation is completed on a best-effort \n basis.
\nFor more information, see \n Time-based copies.
" } }, "DryRun": { @@ -15908,7 +15943,7 @@ "DisconnectOnSessionTimeout": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. \n The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. \n The default value is true.
Delegates ownership of the Amazon EBS root volume for an Apple silicon \n Mac instance to an administrative user.
" + } + }, + "com.amazonaws.ec2#CreateDelegateMacVolumeOwnershipTaskRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Amazon EC2 Mac instance.
", + "smithy.api#required": {} + } + }, + "MacCredentials": { + "target": "com.amazonaws.ec2#SensitiveMacCredentials", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the following credentials:
\n\n Internal disk administrative user\n
\n\n Username - Only the default administrative user \n (aws-managed-user) is supported and it is used by default. You can't \n specify a different administrative user.
\n Password - If you did not change the default \n password for aws-managed-user, specify the default password, which is \n blank. Otherwise, specify your password.
\n Amazon EBS root volume administrative user\n
\n\n Username - If you did not change the default \n administrative user, specify ec2-user. Otherwise, specify the username \n for your administrative user.
\n Password - Specify the password for the \n administrative user.
\nThe credentials must be specified in the following JSON format:
\n\n {\n \"internalDiskPassword\":\"internal-disk-admin_password\",\n \"rootVolumeUsername\":\"root-volume-admin_username\",\n \"rootVolumepassword\":\"root-volume-admin_password\"\n}\n
The tags to assign to the volume ownership delegation task.
", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateDelegateMacVolumeOwnershipTaskResult": { + "type": "structure", + "members": { + "MacModificationTask": { + "target": "com.amazonaws.ec2#MacModificationTask", + "traits": { + "aws.protocols#ec2QueryName": "MacModificationTask", + "smithy.api#documentation": "Information about the volume ownership delegation task.
", + "smithy.api#xmlName": "macModificationTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateDhcpOptions": { "type": "operation", "input": { @@ -17904,7 +18011,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Store\n instance launch parameters in Amazon EC2 launch templates in the\n Amazon EC2 User Guide.
\nTo clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Store\n instance launch parameters in Amazon EC2 launch templates in the\n Amazon EC2 User Guide.
\nTo clone an existing launch template as the basis for a new launch template, use the\n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more\n information, see Create a launch template from an existing launch template in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template", @@ -17962,7 +18069,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the\n request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", "smithy.api#idempotencyToken": {} } }, @@ -17997,7 +18104,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch template data structure.
The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched,\n you must use the TagSpecifications parameter in the launch template\n data structure.
Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.
\nLaunch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits\n parameters from a source version, and add or overwrite parameters as needed.
\nLaunch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.
\nFor more information, see Modify a launch\n template (manage launch template versions) in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template version", @@ -18095,26 +18202,26 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the\n request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", "smithy.api#idempotencyToken": {} } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "SourceVersion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The version of the launch template on which to base the new version. \n Snapshots applied to the block device mapping are ignored when creating a new version \n unless they are explicitly included.
\nIf you specify this parameter, the new version inherits the launch parameters from the\n source version. If you specify additional launch parameters for the new version, they \n overwrite any corresponding launch parameters inherited from the source version.
\nIf you omit this parameter, the new version contains only the launch parameters\n that you specify for the new version.
" + "smithy.api#documentation": "The version of the launch template on which to base the new version. Snapshots applied\n to the block device mapping are ignored when creating a new version unless they are\n explicitly included.
\nIf you specify this parameter, the new version inherits the launch parameters from the\n source version. If you specify additional launch parameters for the new version, they\n overwrite any corresponding launch parameters inherited from the source version.
\nIf you omit this parameter, the new version contains only the launch parameters that\n you specify for the new version.
" } }, "VersionDescription": { @@ -18603,6 +18710,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#CreateMacSystemIntegrityProtectionModificationTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateMacSystemIntegrityProtectionModificationTaskRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateMacSystemIntegrityProtectionModificationTaskResult" + }, + "traits": { + "smithy.api#documentation": "Creates a System Integrity Protection (SIP) modification task to configure the SIP settings \n for an x86 Mac instance or Apple silicon Mac instance. For more information, see \n \n Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
\nWhen you configure the SIP settings for your instance, you can either enable \n or disable all SIP settings, or you can specify a custom SIP configuration that \n selectively enables or disables specific SIP settings.
\nIf you implement a custom configuration, \n connect to the instance and verify the settings to ensure that your \n requirements are properly implemented and functioning as intended.
\nSIP configurations might change with macOS updates. We recommend that you \n review custom SIP settings after any macOS version upgrade to ensure \n continued compatibility and proper functionality of your security configurations.
\nTo enable or disable all SIP settings, use the MacSystemIntegrityProtectionStatus \n parameter only. For example, to enable all SIP settings, specify the following:
\n\n MacSystemIntegrityProtectionStatus=enabled\n
To specify a custom configuration that selectively enables or disables specific SIP \n settings, use the MacSystemIntegrityProtectionStatus \n parameter to enable or disable all SIP settings, and then use the \n MacSystemIntegrityProtectionConfiguration parameter \n to specify exceptions. In this case, the exceptions you specify for MacSystemIntegrityProtectionConfiguration override the value \n you specify for MacSystemIntegrityProtectionStatus. \n For example, to enable all SIP settings, except NvramProtections, \n specify the following:
\n MacSystemIntegrityProtectionStatus=enabled\n
\n MacSystemIntegrityProtectionConfigurationRequest \"NvramProtections=disabled\"\n
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Amazon EC2 Mac instance.
", + "smithy.api#required": {} + } + }, + "MacCredentials": { + "target": "com.amazonaws.ec2#SensitiveMacCredentials", + "traits": { + "smithy.api#documentation": "\n [Apple silicon Mac instances only] Specifies the \n following credentials:
\n\n Internal disk administrative user\n
\n\n Username - Only the default administrative \n user (aws-managed-user) is supported and it is used by default. You \n can't specify a different administrative user.
\n Password - If you did not change the default \n password for aws-managed-user, specify the default password, which \n is blank. Otherwise, specify your password.
\n Amazon EBS root volume administrative user\n
\n\n Username - If you did not change the default \n administrative user, specify ec2-user. Otherwise, specify the username \n for your administrative user.
\n Password - Specify the password for the \n administrative user.
\nThe credentials must be specified in the following JSON format:
\n\n {\n \"internalDiskPassword\":\"internal-disk-admin_password\",\n \"rootVolumeUsername\":\"root-volume-admin_username\",\n \"rootVolumepassword\":\"root-volume-admin_password\"\n}\n
Specifies the overrides to selectively enable or disable individual SIP settings. \n The individual settings you specify here override the overall SIP status you specify \n for MacSystemIntegrityProtectionStatus.
" + } + }, + "MacSystemIntegrityProtectionStatus": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the overall SIP status for the instance. To enable all SIP settings, specify \n enabled. To disable all SIP settings, specify disabled.
Specifies tags to apply to the SIP modification task.
", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateMacSystemIntegrityProtectionModificationTaskResult": { + "type": "structure", + "members": { + "MacModificationTask": { + "target": "com.amazonaws.ec2#MacModificationTask", + "traits": { + "aws.protocols#ec2QueryName": "MacModificationTask", + "smithy.api#documentation": "Information about the SIP modification task.
", + "smithy.api#xmlName": "macModificationTask" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateManagedPrefixList": { "type": "operation", "input": { @@ -19260,7 +19451,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" }, "traits": { - "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type.
\nFor more information about network interfaces, see Elastic network interfaces in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermission": { @@ -19272,7 +19463,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" }, "traits": { - "smithy.api#documentation": "Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.
\nYou can grant permission to a single Amazon Web Services account only, and only one account at a time.
" + "smithy.api#documentation": "Grants an Amazon Web Services-authorized account permission to attach the specified\n network interface to an instance in their account.
\nYou can grant permission to a single Amazon Web Services account only, and only one\n account at a time.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { @@ -19309,7 +19500,7 @@ "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
The IPv4 prefixes assigned to the network interface.
\nYou can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", + "smithy.api#documentation": "The IPv4 prefixes assigned to the network interface.
\nYou can't specify IPv4 prefixes if you've specified one of the following: a count of\n IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
", "smithy.api#xmlName": "Ipv4Prefix" } }, "Ipv4PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
" + "smithy.api#documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the\n network interface.
\nYou can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.
" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#Ipv6PrefixList", "traits": { - "smithy.api#documentation": "The IPv6 prefixes assigned to the network interface.
\nYou can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", + "smithy.api#documentation": "The IPv6 prefixes assigned to the network interface.
\nYou can't specify IPv6 prefixes if you've specified one of the following: a count of\n IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", "smithy.api#xmlName": "Ipv6Prefix" } }, "Ipv6PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
\nYou can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" + "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the\n network interface.
\nYou can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" } }, "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "The type of network interface. The default is interface.
If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.
The only supported values are interface, efa, efa-only, and trunk.
The type of network interface. The default is interface.
If you specify efa-only, do not assign any IP addresses to the network\n interface. EFA-only network interfaces do not support IP addresses.
The only supported values are interface, efa,\n efa-only, and trunk.
If you\u2019re creating a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that\n this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services\n will automatically assign an IPv6 address associated with the ENI attached to your\n instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a\n primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary\n IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is\n terminated or the network interface is detached. If you have multiple IPv6 addresses\n associated with an ENI attached to your instance and you enable a primary IPv6 address,\n the first IPv6 GUA address associated with the ENI becomes the primary IPv6\n address.
" + "smithy.api#documentation": "If you\u2019re creating a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.
" } }, "ConnectionTrackingSpecification": { @@ -19424,7 +19615,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).
The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).
The private IPv4 addresses.
\nYou can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "smithy.api#documentation": "The private IPv4 addresses.
\nYou can't specify private IPv4 addresses if you've specified one of the following: a\n count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4\n prefixes.
", "smithy.api#xmlName": "privateIpAddresses" } }, @@ -19447,7 +19638,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "smithy.api#documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the\n following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4\n prefixes.
", "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, @@ -19455,7 +19646,7 @@ "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "The IPv6 addresses from the IPv6 CIDR block range of your subnet.
\nYou can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", + "smithy.api#documentation": "The IPv6 addresses from the IPv6 CIDR block range of your subnet.
\nYou can't specify IPv6 addresses using this parameter if you've specified one of the\n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6\n prefixes.
", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -19463,7 +19654,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.
\nYou can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
\nIf your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.
The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.
\nYou can't specify a count of IPv6 addresses using this parameter if you've specified\n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of\n IPv6 prefixes.
\nIf your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Indicates whether to automatically delete the original root volume after the root volume \n replacement task completes. To delete the original root volume, specify true. \n If you choose to keep the original root volume after the replacement task completes, you must \n manually delete it when you no longer need it.
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download \n the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as \n volume initialization. Specifying a volume initialization rate ensures that \n the volume is initialized at a predictable and consistent rate after creation.
\nOmit this parameter if:
\nYou want to create the volume using fast snapshot restore. You must specify a snapshot \n that is enabled for fast snapshot restore. In this case, the volume is fully initialized at \n creation.
\nIf you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, \n the volume will be initialized at the specified rate instead of fast snapshot restore.
\nYou want to create a volume that is initialized at the default rate.
\nFor more information, see \n Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
\nValid range: 100 - 300 MiB/s
" + } } }, "traits": { @@ -19740,7 +19937,7 @@ "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" }, "traits": { - "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nTo sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved\n Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get\n a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace.\n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved\n Instance capacity that they no longer need with buyers who want to purchase additional\n capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work\n like any other Reserved Instances.
\nTo sell your Standard Reserved Instances, you must first register as a seller in the\n Reserved Instance Marketplace. After completing the registration process, you can create a\n Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and\n specify the upfront price to receive for them. Your Standard Reserved Instance listings then\n become available for purchase. To view the details of your Standard Reserved Instance listing,\n you can use the DescribeReservedInstancesListings operation.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { @@ -19761,7 +19958,7 @@ "traits": { "aws.protocols#ec2QueryName": "InstanceCount", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
", + "smithy.api#documentation": "The number of instances that are a part of a Reserved Instance account to be listed in the\n Reserved Instance Marketplace. This number should be less than or equal to the instance count\n associated with the Reserved Instance ID specified in this call.
", "smithy.api#required": {}, "smithy.api#xmlName": "instanceCount" } @@ -19771,7 +19968,7 @@ "traits": { "aws.protocols#ec2QueryName": "PriceSchedules", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
", + "smithy.api#documentation": "A list specifying the price of the Standard Reserved Instance for each month remaining in\n the Reserved Instance term.
", "smithy.api#required": {}, "smithy.api#xmlName": "priceSchedules" } @@ -19781,7 +19978,7 @@ "traits": { "aws.protocols#ec2QueryName": "ClientToken", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This\n helps avoid duplicate listings. For more information, see Ensuring\n Idempotency.
", "smithy.api#required": {}, "smithy.api#xmlName": "clientToken" } @@ -23248,6 +23445,12 @@ "smithy.api#idempotencyToken": {} } }, + "VolumeInitializationRate": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download \n the snapshot blocks from Amazon S3 to the volume. This is also known as volume \n initialization. Specifying a volume initialization rate ensures that the volume is \n initialized at a predictable and consistent rate after creation.
\nThis parameter is supported only for volumes created from snapshots. Omit this parameter \n if:
\nYou want to create the volume using fast snapshot restore. You must specify a snapshot \n that is enabled for fast snapshot restore. In this case, the volume is fully initialized at \n creation.
\nIf you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, \n the volume will be initialized at the specified rate instead of fast snapshot restore.
\nYou want to create a volume that is initialized at the default rate.
\nFor more information, see \n Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
\nValid range: 100 - 300 MiB/s
" + } + }, "Operator": { "target": "com.amazonaws.ec2#OperatorRequest", "traits": { @@ -24507,6 +24710,9 @@ } } }, + "com.amazonaws.ec2#DefaultEnaQueueCountPerInterface": { + "type": "integer" + }, "com.amazonaws.ec2#DefaultInstanceMetadataEndpointState": { "type": "enum", "members": { @@ -25856,13 +26062,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } } }, @@ -25932,13 +26138,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "Versions": { @@ -26819,7 +27025,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified network interface. You must detach the network interface before you can delete it.
", + "smithy.api#documentation": "Deletes the specified network interface. You must detach the network interface before\n you can delete it.
", "smithy.api#examples": [ { "title": "To delete a network interface", @@ -26840,7 +27046,7 @@ "target": "com.amazonaws.ec2#DeleteNetworkInterfacePermissionResult" }, "traits": { - "smithy.api#documentation": "Deletes a permission for a network interface. By default, you cannot delete the\n\t\t\tpermission if the account for which you're removing the permission has attached the\n\t\t\tnetwork interface to an instance. However, you can force delete the permission,\n\t\t\tregardless of any attachment.
" + "smithy.api#documentation": "Deletes a permission for a network interface. By default, you cannot delete the\n permission if the account for which you're removing the permission has attached the\n network interface to an instance. However, you can force delete the permission,\n regardless of any attachment.
" } }, "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest": { @@ -26857,13 +27063,13 @@ "Force": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Specify true to remove the permission even if the network interface is\n\t\t\tattached to an instance.
Specify true to remove the permission even if the network interface is\n attached to an instance.
Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Describes the error for a Reserved Instance whose queued purchase could not be deleted.
" + "smithy.api#documentation": "Describes the error for a Reserved Instance whose queued purchase could not be\n deleted.
" } }, "com.amazonaws.ec2#DeleteQueuedReservedInstancesErrorCode": { @@ -27100,7 +27306,7 @@ "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.
\nThe images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
\nWhen Allowed AMIs is set to enabled, only allowed images are returned in the\n results, with the imageAllowed field set to true for each image. In\n audit-mode, the imageAllowed field is set to true for\n images that meet the account's Allowed AMIs criteria, and false for images that\n don't meet the criteria. For more information, see EnableAllowedImagesSettings.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nDescribes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.
\nThe images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
\nWhen Allowed AMIs is set to enabled, only allowed images are returned in the\n results, with the imageAllowed field set to true for each image. In\n audit-mode, the imageAllowed field is set to true for\n images that meet the account's Allowed AMIs criteria, and false for images that\n don't meet the criteria. For more information, see EnableAllowedImagesSettings.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API\n command you run that creates or modifies resources might not be immediately available to all\n subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual\n consistency in the Amazon EC2 API in the Amazon EC2 Developer\n Guide.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nDescribes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nThe Amazon EC2 API follows an eventual consistency model. This means that the result of an\n API command you run that creates or modifies resources might not be immediately\n available to all subsequent commands you run. For guidance on how to manage eventual\n consistency, see Eventual consistency in the\n Amazon EC2 API in the Amazon EC2 Developer\n Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes a tree-based hierarchy that represents the physical host placement of your\n EC2 instances within an Availability Zone or Local Zone. You can use this information to\n determine the relative proximity of your EC2 instances within the Amazon Web Services network to\n support your tightly coupled workloads.
\n\n Limitations\n
\nSupported zones
\nAvailability Zone
\nLocal Zone
\nSupported instance types
\n\n hpc6a.48xlarge | hpc6id.32xlarge |\n hpc7a.12xlarge | hpc7a.24xlarge |\n hpc7a.48xlarge | hpc7a.96xlarge |\n hpc7g.4xlarge | hpc7g.8xlarge |\n hpc7g.16xlarge\n
\n p3dn.24xlarge | p4d.24xlarge |\n p4de.24xlarge | p5.48xlarge |\n p5e.48xlarge | p5en.48xlarge\n
\n trn1.2xlarge | trn1.32xlarge |\n trn1n.32xlarge | trn2.48xlarge |\n trn2u.48xlarge\n
For more information, see Amazon EC2 instance\n topology in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes a tree-based hierarchy that represents the physical host placement of your\n EC2 instances within an Availability Zone or Local Zone. You can use this information to\n determine the relative proximity of your EC2 instances within the Amazon Web Services network to\n support your tightly coupled workloads.
\n\n Limitations\n
\nSupported zones
\nAvailability Zone
\nLocal Zone
\nSupported instance types
\nReturns 3 network nodes in the response
\n\n hpc6a.48xlarge | hpc6id.32xlarge |\n hpc7a.12xlarge | hpc7a.24xlarge |\n hpc7a.48xlarge | hpc7a.96xlarge |\n hpc7g.4xlarge | hpc7g.8xlarge |\n hpc7g.16xlarge\n
\n p3dn.24xlarge | p4d.24xlarge |\n p4de.24xlarge | p5.48xlarge |\n p5e.48xlarge | p5en.48xlarge\n
\n trn1.2xlarge | trn1.32xlarge |\n trn1n.32xlarge | trn2.48xlarge |\n trn2u.48xlarge\n
Returns 4 network nodes in the response
\n\n p6-b200.48xlarge\n
For more information, see Amazon EC2 instance\n topology in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35318,7 +35524,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).
\n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n dedicated-hosts-supported - Indicates whether the instance type supports\n Dedicated Hosts. (true | false)
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.bandwidth-weightings - For instances that support bandwidth \n weighting to boost performance (default, vpc-1, ebs-1).
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).
\n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).
\n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.
\n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand | spot | \n capacity-block).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance\n type.
\n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).
\n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n dedicated-hosts-supported - Indicates whether the instance type supports\n Dedicated Hosts. (true | false)
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.bandwidth-weightings - For instances that support bandwidth\n weighting to boost performance (default, vpc-1,\n ebs-1).
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.flexible-ena-queues-support - Indicates whether an instance supports\n flexible ENA queues (supported | unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).
\n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).
\n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.
\n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).
\n reboot-migration-support - Indicates whether enabling reboot migration is\n supported (supported | unsupported).
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot | capacity-block).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance\n type.
\n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".
Describes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
\nThe Amazon EC2 API follows an eventual consistency model. This means that the result of an\n API command you run that creates or modifies resources might not be immediately\n available to all subsequent commands you run. For guidance on how to manage eventual\n consistency, see Eventual consistency in the\n Amazon EC2 API in the Amazon EC2 Developer\n Guide.
\nWe strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nIf true, and if a Systems Manager parameter is specified for ImageId,\n the AMI ID is displayed in the response for imageId.
If false, and if a Systems Manager parameter is specified for ImageId,\n the parameter is displayed in the response for imageId.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
\nDefault: false\n
If true, and if a Systems Manager parameter is specified for\n ImageId, the AMI ID is displayed in the response for\n imageId.
If false, and if a Systems Manager parameter is specified for\n ImageId, the parameter is displayed in the response for\n imageId.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
\nDefault: false\n
Describes a System Integrity Protection (SIP) modification task or volume ownership delegation \n task for an Amazon EC2 Mac instance. For more information, see Configure \n SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MacModificationTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeMacModificationTasksMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.ec2#DescribeMacModificationTasksRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Specifies one or more filters for the request:
\n\n instance-id - The ID of the instance for which the task was created.
\n task-state - The state of the task (successful | failed | \n in-progress | pending).
\n mac-system-integrity-protection-configuration.sip-status - The overall SIP \n state requested in the task (enabled | disabled).
\n start-time - The date and time the task was created.
\n task-type - The type of task (sip-modification | volume-ownership-delegation).
The ID of task.
", + "smithy.api#xmlName": "MacModificationTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeMacModificationTasksMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The token to use to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeMacModificationTasksResult": { + "type": "structure", + "members": { + "MacModificationTasks": { + "target": "com.amazonaws.ec2#MacModificationTaskList", + "traits": { + "aws.protocols#ec2QueryName": "MacModificationTaskSet", + "smithy.api#documentation": "Information about the tasks.
", + "smithy.api#xmlName": "macModificationTaskSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a network interface attribute. You can specify only one attribute at a time.
", + "smithy.api#documentation": "Describes a network interface attribute. You can specify only one attribute at a\n time.
", "smithy.api#examples": [ { "title": "To describe the attachment attribute of a network interface", @@ -38501,7 +38798,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
", + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. This option\n can be enabled for any network interface but will only apply to the primary network\n interface (eth0).
", "smithy.api#xmlName": "associatePublicIpAddress" } } @@ -38626,20 +38923,20 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n network-interface-permission.network-interface-permission-id - The ID of the\n\t\t\t\tpermission.
\n network-interface-permission.network-interface-id - The ID of\n\t\t\t\t\tthe network interface.
\n network-interface-permission.aws-account-id - The Amazon Web Services account ID.
\n network-interface-permission.aws-service - The Amazon Web Services service.
\n network-interface-permission.permission - The type of\n\t\t\t\t\tpermission (INSTANCE-ATTACH |\n\t\t\t\t\tEIP-ASSOCIATE).
One or more filters.
\n\n network-interface-permission.network-interface-permission-id -\n The ID of the permission.
\n network-interface-permission.network-interface-id - The ID of the\n network interface.
\n network-interface-permission.aws-account-id - The Amazon Web Services account ID.
\n network-interface-permission.aws-service - The Amazon Web Services\n service.
\n network-interface-permission.permission - The type of permission\n (INSTANCE-ATTACH | EIP-ASSOCIATE).
The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the\n end of the items returned by the previous request.
" } }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items,\n\t\t\tmake another request with the token returned in the output. If this parameter is not specified, \n\t\t\tup to 50 results are returned by default. For more information, see\n\t\t\tPagination.
" + "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. If this parameter is not\n specified, up to 50 results are returned by default. For more information, see Pagination.
" } } }, @@ -38663,7 +38960,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to get the next page of items.\n\t\t This value is null when there are no more items to return.
The token to include in another request to get the next page of items. This value is\n null when there are no more items to return.
Describes the specified network interfaces or all your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nDescribes the specified network interfaces or all your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless you use\n pagination or one of the following filters: group-id,\n mac-address, private-dns-name,\n private-ip-address, subnet-id, or\n vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the\n end of the items returned by the previous request.
" } }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.
" + "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. You cannot specify this\n parameter and the network interface IDs parameter in the same request. For more\n information, see Pagination.
" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
One or more filters.
\n\n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.
\n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | \n\t\t efa | efa-only | efs | gateway_load_balancer | \n\t\t gateway_load_balancer_endpoint | global_accelerator_managed | interface | \n\t\t iot_rules_managed | lambda | load_balancer | nat_gateway | \n\t\t network_load_balancer | quicksight | transit_gateway | trunk | \n\t\t vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n operator.managed - A Boolean that indicates whether this is a\n managed network interface.
\n operator.principal - The principal that manages the network\n interface. Only valid for managed network interfaces, where managed\n is true.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services \n\t\t service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
One or more filters.
\n\n association.allocation-id - The allocation ID returned when you\n allocated the Elastic IP address (IPv4) for your network interface.
\n association.association-id - The association ID returned when the\n network interface was associated with an IPv4 address.
\n addresses.association.owner-id - The owner ID of the addresses\n associated with the network interface.
\n addresses.association.public-ip - The association ID returned\n when the network interface was associated with the Elastic IP address\n (IPv4).
\n addresses.primary - Whether the private IPv4 address is the\n primary IP address associated with the network interface.
\n addresses.private-ip-address - The private IPv4 addresses\n associated with the network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attach-time - The time that the network interface was\n attached to an instance.
\n attachment.attachment-id - The ID of the interface\n attachment.
\n attachment.delete-on-termination - Indicates whether the\n attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network\n interface is attached.
\n attachment.instance-id - The ID of the instance to which the\n network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to\n which the network interface is attached.
\n attachment.status - The status of the attachment\n (attaching | attached | detaching |\n detached).
\n availability-zone - The Availability Zone of the network\n interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network\n interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with the\n network interface.
\n interface-type - The type of network interface\n (api_gateway_managed |\n aws_codestar_connections_managed | branch |\n ec2_instance_connect_endpoint | efa |\n efa-only | efs |\n gateway_load_balancer |\n gateway_load_balancer_endpoint |\n global_accelerator_managed | interface |\n iot_rules_managed | lambda |\n load_balancer | nat_gateway |\n network_load_balancer | quicksight |\n transit_gateway | trunk |\n vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n operator.managed - A Boolean that indicates whether this is a\n managed network interface.
\n operator.principal - The principal that manages the network\n interface. Only valid for managed network interfaces, where managed\n is true.
\n owner-id - The Amazon Web Services account ID of the network\n interface owner.
\n private-dns-name - The private DNS name of the network interface\n (IPv4).
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n requester-id - The alias or Amazon Web Services account ID of the\n principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is\n being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface\n performs source/destination checking. A value of true means\n checking is enabled, and false means checking is disabled. The\n value must be false for the network interface to perform network\n address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network\n interface is not attached to an instance, the status is available;\n if a network interface is attached to an instance the status is\n in-use.
\n subnet-id - The ID of the subnet for the network\n interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
The token to include in another request to get the next page of items. \n\t\t This value is null when there are no more items to return.
The token to include in another request to get the next page of items. This value is\n null when there are no more items to return.
Describes the Outposts link aggregation groups (LAGs).
" + "smithy.api#documentation": "Describes the Outposts link aggregation groups (LAGs).
\nLAGs are only available for second-generation Outposts racks at this time.
\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n Instances in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nDescribes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes your account's Reserved Instance listings in the Reserved Instance\n Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance\n capacity that they no longer need with buyers who want to purchase additional capacity.\n Reserved Instances bought and sold through the Reserved Instance Marketplace work like any\n other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify\n the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved\n Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the\n Marketplace matches what you're searching for with what's available. The Marketplace first\n sells the lowest priced Reserved Instances to you, and continues to sell available Reserved\n Instance listings to you until your demand is met. You are charged based on the total price of\n all of the listings that you purchase.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nOne or more filters.
\n\n reserved-instances-id - The ID of the Reserved Instances.
\n reserved-instances-listing-id - The ID of the Reserved Instances listing.
\n status - The status of the Reserved Instance listing (pending | active |\n cancelled | closed).
\n status-message - The reason for the status.
One or more filters.
\n\n reserved-instances-id - The ID of the Reserved Instances.
\n reserved-instances-listing-id - The ID of the Reserved Instances\n listing.
\n status - The status of the Reserved Instance listing (pending |\n active | cancelled | closed).
\n status-message - The reason for the status.
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the modifications made to your Reserved Instances. If no parameter is specified,\n information about all your Reserved Instances modification requests is returned. If a\n modification ID is specified, only information about the specific modification is\n returned.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nOne or more filters.
\n\n client-token - The idempotency token for the modification request.
\n create-date - The time when the modification request was created.
\n effective-date - The time when the modification becomes effective.
\n modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
\n modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
\n modification-result.target-configuration.instance-count - The number of new Reserved Instances.
\n modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
\n reserved-instances-id - The ID of the Reserved Instances modified.
\n reserved-instances-modification-id - The ID of the modification request.
\n status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).
\n status-message - The reason for the status.
\n update-date - The time when the modification request was last updated.
One or more filters.
\n\n client-token - The idempotency token for the modification request.
\n create-date - The time when the modification request was created.
\n effective-date - The time when the modification becomes effective.
\n modification-result.reserved-instances-id - The ID for the Reserved Instances\n created as part of the modification request. This ID is only available when the status of\n the modification is fulfilled.
\n modification-result.target-configuration.availability-zone - The Availability\n Zone for the new Reserved Instances.
\n modification-result.target-configuration.availability-zone-id - The ID of the\n Availability Zone for the new Reserved Instances.
\n modification-result.target-configuration.instance-count - The number of new\n Reserved Instances.
\n modification-result.target-configuration.instance-type - The instance type of\n the new Reserved Instances.
\n reserved-instances-id - The ID of the Reserved Instances modified.
\n reserved-instances-modification-id - The ID of the modification\n request.
\n status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).
\n status-message - The reason for the status.
\n update-date - The time when the modification request was last updated.
The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes Reserved Instance offerings that are available for purchase. With Reserved\n Instances, you purchase the right to launch instances for a period of time. During that time\n period, you do not receive insufficient capacity errors, and you pay a lower usage rate than\n the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance\n Marketplace, they will be excluded from these results. This is to ensure that you do not\n purchase your own Reserved Instances.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nThe Availability Zone in which the Reserved Instance can be used.
" + "smithy.api#documentation": "The Availability Zone in which the Reserved Instance can be used.
\nEither AvailabilityZone or AvailabilityZoneId can be specified,\n but not both.
The offering class of the Reserved Instance. Can be standard or convertible.
The offering class of the Reserved Instance. Can be standard or\n convertible.
The ID of the Availability Zone.
\nEither AvailabilityZone or AvailabilityZoneId can be specified,\n but not both.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
One or more filters.
\n\n availability-zone - The Availability Zone where the Reserved Instance can be\n used.
\n duration - The duration of the Reserved Instance (for example, one year or\n three years), in seconds (31536000 | 94608000).
\n fixed-price - The purchase price of the Reserved Instance (for example,\n 9800.0).
\n instance-type - The instance type that is covered by the\n reservation.
\n marketplace - Set to true to show only Reserved Instance\n Marketplace offerings. When this filter is not used, which is the default behavior, all\n offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
\n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).
\n reserved-instances-offering-id - The Reserved Instances offering\n ID.
\n scope - The scope of the Reserved Instance (Availability Zone or\n Region).
\n usage-price - The usage price of the Reserved Instance, per hour (for\n example, 0.84).
One or more filters.
\n\n availability-zone - The Availability Zone where the Reserved Instance can be\n used.
\n availability-zone-id - The ID of the Availability Zone where the Reserved\n Instance can be used.
\n duration - The duration of the Reserved Instance (for example, one year or\n three years), in seconds (31536000 | 94608000).
\n fixed-price - The purchase price of the Reserved Instance (for example,\n 9800.0).
\n instance-type - The instance type that is covered by the reservation.
\n marketplace - Set to true to show only Reserved Instance\n Marketplace offerings. When this filter is not used, which is the default behavior, all\n offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
\n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard | Linux\n with SQL Server Web | Linux with SQL Server Enterprise | SUSE\n Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux\n with HA | Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server\n Enterprise).
\n reserved-instances-offering-id - The Reserved Instances offering ID.
\n scope - The scope of the Reserved Instance (Availability Zone or\n Region).
\n usage-price - The usage price of the Reserved Instance, per hour (for\n example, 0.84).
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).
\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default\n
The tenancy of the instances covered by the reservation. A Reserved Instance with a\n tenancy of dedicated is applied to instances that run in a VPC on single-tenant\n hardware (i.e., Dedicated Instances).
\n Important: The host value cannot be used with\n this parameter. Use the default or dedicated values only.
Default: default\n
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01\n API version, you only have access to the Medium Utilization Reserved Instance\n offering type.
The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.
Default: 100
", + "smithy.api#documentation": "The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. The maximum is 100.
Default: 100
", "smithy.api#xmlName": "maxResults" } } @@ -39746,7 +40049,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
One or more filters.
\n\n availability-zone - The Availability Zone where the Reserved Instance can be used.
\n duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
\n end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
\n fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
\n instance-type - The instance type that is covered by the reservation.
\n scope - The scope of the Reserved Instance (Region or Availability Zone).
\n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).
\n reserved-instances-id - The ID of the Reserved Instance.
\n start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
\n state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
\n\n availability-zone - The Availability Zone where the Reserved Instance can\n be used.
\n availability-zone-id - The ID of the Availability Zone where the Reserved\n Instance can be used.
\n duration - The duration of the Reserved Instance (one year or three\n years), in seconds (31536000 | 94608000).
\n end - The time when the Reserved Instance expires (for example,\n 2015-08-07T11:54:42.000Z).
\n fixed-price - The purchase price of the Reserved Instance (for example,\n 9800.0).
\n instance-type - The instance type that is covered by the\n reservation.
\n scope - The scope of the Reserved Instance (Region or\n Availability Zone).
\n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard | Linux\n with SQL Server Web | Linux with SQL Server Enterprise | SUSE\n Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux\n with HA | Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server\n Enterprise).
\n reserved-instances-id - The ID of the Reserved Instance.
\n start - The time at which the Reserved Instance purchase request was\n placed (for example, 2014-08-07T11:54:42.000Z).
\n state - The state of the Reserved Instance (payment-pending\n | active | payment-failed | retired).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n usage-price - The usage price of the Reserved Instance, per hour (for\n example, 0.84).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01\n API version, you only have access to the Medium Utilization Reserved Instance\n offering type.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Specifies whether to force a detachment.
\nUse the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.
\nSpecifies whether to force a detachment.
\nUse the Force parameter only as a last resort to detach a\n network interface from a failed instance.
If you use the Force parameter to detach a network interface,\n you might not be able to attach a different network interface to the same\n index on the instance without first stopping and starting the\n instance.
If you force the detachment of a network interface, the instance\n metadata might not get updated. This means that the attributes\n associated with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.
\nIndicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.
\nThis parameter is not returned by DescribeImageAttribute.
\nFor CreateImage and RegisterImage, whether you can \n include this parameter, and the allowed values differ depending on the type of block \n device mapping you are creating.
\nIf you are creating a block device mapping for a new (empty) \n volume, you can include this parameter, and specify either true \n for an encrypted volume, or false for an unencrypted volume. If you omit \n this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing \n encrypted or unencrypted snapshot, you must omit this parameter. If you \n include this parameter, the request will fail, regardless of the value that you \n specify.
\nIf you are creating a block device mapping from an existing \n unencrypted volume, you can include this parameter, but you must specify \n false. If you specify true, the request will fail. In this \n case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing \n encrypted volume, you can include this parameter, and specify either \n true or false. However, if you specify false, \n the parameter is ignored and the block device mapping is always encrypted. In this \n case, we recommend that you omit the parameter.
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download \n the snapshot blocks from Amazon S3 to the volume. This is also known as \n volume initialization. Specifying a volume initialization rate ensures that \n the volume is initialized at a predictable and consistent rate after creation.
\nThis parameter is supported only for volumes created from snapshots. Omit this parameter \n if:
\nYou want to create the volume using fast snapshot restore. You must specify a snapshot \n that is enabled for fast snapshot restore. In this case, the volume is fully initialized at \n creation.
\nIf you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, \n the volume will be initialized at the specified rate instead of fast snapshot restore.
\nYou want to create a volume that is initialized at the default rate.
\nFor more information, see \n Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
\nThis parameter is not supported when using CreateImage.
\nValid range: 100 - 300 MiB/s
" + } } }, "traits": { @@ -49758,7 +50067,7 @@ "target": "com.amazonaws.ec2#EbsOptimizedSupport", "traits": { "aws.protocols#ec2QueryName": "EbsOptimizedSupport", - "smithy.api#documentation": "Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.
", + "smithy.api#documentation": "Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.
", "smithy.api#xmlName": "ebsOptimizedSupport" } }, @@ -50693,18 +51002,18 @@ "EnaSrdEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether ENA Express is enabled for the network interface when you \n\t\t\tlaunch an instance.
" + "smithy.api#documentation": "Specifies whether ENA Express is enabled for the network interface when you launch an\n instance.
" } }, "EnaSrdUdpSpecification": { "target": "com.amazonaws.ec2#EnaSrdUdpSpecificationRequest", "traits": { - "smithy.api#documentation": "Contains ENA Express settings for UDP network traffic for the network interface \n\t attached to the instance.
" + "smithy.api#documentation": "Contains ENA Express settings for UDP network traffic for the network interface\n attached to the instance.
" } } }, "traits": { - "smithy.api#documentation": "Launch instances with ENA Express settings configured \n\t\t\tfrom your launch template.
" + "smithy.api#documentation": "Launch instances with ENA Express settings configured from your launch\n template.
" } }, "com.amazonaws.ec2#EnaSrdSupported": { @@ -50730,7 +51039,7 @@ "EnaSrdUdpEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether UDP traffic uses ENA Express for your instance. To ensure that \n\t\t\tUDP traffic can use ENA Express when you launch an instance, you must also set \n\t\t\tEnaSrdEnabled in the EnaSrdSpecificationRequest to true.
Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP\n traffic can use ENA Express when you launch an instance, you must also set EnaSrdEnabled in the EnaSrdSpecificationRequest to true.
The IDs of the Availability Zones.
", + "smithy.api#xmlName": "availabilityZoneIdSet" + } + }, "Cidrs": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -54797,7 +55114,7 @@ } }, "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "The ID of the AMI in the format ami-17characters00000.
Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.
\nTo reference a public parameter:
\n\n resolve:ssm:public-parameter\n \n
To reference a parameter stored in the same account:
\n\n resolve:ssm:parameter-name\n \n
\n resolve:ssm:parameter-name:version-number\n \n
\n resolve:ssm:parameter-name:label\n \n
To reference a parameter shared from another Amazon Web Services account:
\n\n resolve:ssm:parameter-ARN\n \n
\n resolve:ssm:parameter-ARN:version-number\n \n
\n resolve:ssm:parameter-ARN:label\n \n
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
\nThis parameter is only available for fleets of type instant. For fleets\n of type maintain and request, you must specify the AMI ID in\n the launch template.
Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, \n DescribeVolumes, and DescribeInstanceAttribute. Or,\n you can allow describe* depending on your instance requirements.
Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes, and\n DescribeInstanceAttribute.\n Or, you can allow describe* depending on your instance requirements.
Returns a quote and exchange information for exchanging one or more specified\n Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange\n cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
" + "smithy.api#documentation": "Returns a quote and exchange information for exchanging one or more specified Convertible\n Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be\n performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
" } }, "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteRequest": { @@ -58352,7 +58686,7 @@ "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.
", + "smithy.api#documentation": "The configuration of the target Convertible Reserved Instance to exchange for your current\n Convertible Reserved Instances.
", "smithy.api#xmlName": "TargetConfiguration" } } @@ -58392,7 +58726,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "IsValidExchange", - "smithy.api#documentation": "If true, the exchange is valid. If false, the exchange cannot be completed.
If true, the exchange is valid. If false, the exchange cannot be\n completed.
The number of listed Reserved Instances in the state specified by the state.
The number of listed Reserved Instances in the state specified by the\n state.
Provides information on the current automatic recovery behavior of your\n instance.
", "smithy.api#xmlName": "autoRecovery" } + }, + "RebootMigration": { + "target": "com.amazonaws.ec2#InstanceRebootMigrationState", + "traits": { + "aws.protocols#ec2QueryName": "RebootMigration", + "smithy.api#documentation": "Specifies whether to attempt reboot migration during a user-initiated reboot of an\n instance that has a scheduled system-reboot event:
\n default - Amazon EC2 attempts to migrate the instance to\n new hardware (reboot migration). If successful, the system-reboot\n event is cleared. If unsuccessful, an in-place reboot occurs and the event\n remains scheduled.
\n disabled - Amazon EC2 keeps the instance on the same\n hardware (in-place reboot). The system-reboot event remains\n scheduled.
This setting only applies to supported instances that have a scheduled reboot event.\n For more information, see Enable or disable reboot migration in the\n Amazon EC2 User Guide.
", + "smithy.api#xmlName": "rebootMigration" + } } }, "traits": { @@ -65644,7 +65986,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "The type of network interface.
\nValid values: interface | efa | efa-only | trunk\n
The type of network interface.
\nValid values: interface | efa | efa-only |\n trunk\n
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Connection tracking timeouts in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingConfiguration" } }, @@ -65756,7 +66098,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", + "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is\n terminated.
", "smithy.api#xmlName": "deleteOnTermination" } }, @@ -65788,9 +66130,17 @@ "target": "com.amazonaws.ec2#InstanceAttachmentEnaSrdSpecification", "traits": { "aws.protocols#ec2QueryName": "EnaSrdSpecification", - "smithy.api#documentation": "Contains the ENA Express settings for the network interface that's attached \n\t\t\tto the instance.
", + "smithy.api#documentation": "Contains the ENA Express settings for the network interface that's attached to\n the instance.
", "smithy.api#xmlName": "enaSrdSpecification" } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnaQueueCount", + "smithy.api#documentation": "The number of ENA queues created with the instance.
", + "smithy.api#xmlName": "enaQueueCount" + } } }, "traits": { @@ -65813,7 +66163,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", - "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.\n The public IP address can only be assigned to a network interface for eth0, and can only\n be assigned to a new network interface, not an existing one. You cannot specify more\n than one network interface in the request. If launching into a default subnet, the\n default value is true.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", "smithy.api#xmlName": "associatePublicIpAddress" } }, @@ -65821,7 +66171,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.
If set to true, the interface is deleted when the instance is terminated.\n You can specify true only if creating a new network interface when\n launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
", + "smithy.api#documentation": "The description of the network interface. Applies only if creating a network interface\n when launching an instance.
", "smithy.api#xmlName": "description" } }, @@ -65837,14 +66187,14 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#documentation": "The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.
\nIf you specify a network interface when launching an instance, \n you must specify the device index.
", + "smithy.api#documentation": "The position of the network interface in the attachment order. A primary network\n interface has a device index of 0.
\nIf you specify a network interface when launching an instance, you must specify the\n device index.
", "smithy.api#xmlName": "deviceIndex" } }, "Groups": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
", + "smithy.api#documentation": "The IDs of the security groups for the network interface. Applies only if creating a\n network interface when launching an instance.
", "smithy.api#xmlName": "SecurityGroupId" } }, @@ -65852,7 +66202,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.
", + "smithy.api#documentation": "A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the\n IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.
", "smithy.api#xmlName": "ipv6AddressCount" } }, @@ -65860,7 +66210,7 @@ "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "The IPv6 addresses to assign to the network interface. You cannot specify\n this option and the option to assign a number of IPv6 addresses in the same request. You\n cannot specify this option if you've specified a minimum number of instances to\n launch.
", + "smithy.api#documentation": "The IPv6 addresses to assign to the network interface. You cannot specify this option\n and the option to assign a number of IPv6 addresses in the same request. You cannot\n specify this option if you've specified a minimum number of instances to launch.
", "smithy.api#xmlName": "ipv6AddressesSet" } }, @@ -65868,7 +66218,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "The ID of the network interface.
\nIf you are creating a Spot Fleet, omit this parameter because you can\u2019t specify a network interface ID in a launch specification.
", + "smithy.api#documentation": "The ID of the network interface.
\nIf you are creating a Spot Fleet, omit this parameter because you can\u2019t specify a\n network interface ID in a launch specification.
", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -65876,7 +66226,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching\n \tmore than one instance in a RunInstances request.
", + "smithy.api#documentation": "The private IPv4 address of the network interface. Applies only if creating a network\n interface when launching an instance. You cannot specify this option if you're launching\n more than one instance in a RunInstances\n request.
", "smithy.api#xmlName": "privateIpAddress" } }, @@ -65884,7 +66234,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.
", + "smithy.api#documentation": "The private IPv4 addresses to assign to the network interface. Only one private IPv4\n address can be designated as primary. You cannot specify this option if you're launching\n more than one instance in a RunInstances\n request.
", "smithy.api#xmlName": "privateIpAddressesSet" } }, @@ -65900,7 +66250,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
", + "smithy.api#documentation": "The ID of the subnet associated with the network interface. Applies only if creating a\n network interface when launching an instance.
", "smithy.api#xmlName": "subnetId" } }, @@ -65913,39 +66263,39 @@ "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The type of network interface.
\nIf you specify efa-only, do not assign any IP addresses to the network \n\t interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
The type of network interface.
\nIf you specify efa-only, do not assign any IP addresses to the network\n interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.
\nIf you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can\u2019t specify the network card index when using this API. To specify the network\n card index, use RunInstances.
" + "smithy.api#documentation": "The index of the network card. Some instance types support multiple network cards. The\n primary network interface must be assigned to network card index 0. The default is\n network card index 0.
\nIf you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can\u2019t specify the network card index when using this API. To specify the network\n card index, use RunInstances.
" } }, "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "The IPv4 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv4PrefixCount option.
The IPv4 delegated prefixes to be assigned to the network interface. You cannot use\n this option if you use the Ipv4PrefixCount option.
The number of IPv4 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefix option.
The number of IPv4 delegated prefixes to be automatically assigned to the network\n interface. You cannot use this option if you use the Ipv4Prefix\n option.
The IPv6 delegated prefixes to be assigned to the network interface. You cannot \n use this option if you use the Ipv6PrefixCount option.
The IPv6 delegated prefixes to be assigned to the network interface. You cannot use\n this option if you use the Ipv6PrefixCount option.
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.
The number of IPv6 delegated prefixes to be automatically assigned to the network\n interface. You cannot use this option if you use the Ipv6Prefix\n option.
Specifies the ENA Express settings for the network interface that's attached to \n\t\t\tthe instance.
" + "smithy.api#documentation": "Specifies the ENA Express settings for the network interface that's attached to\n the instance.
" } }, "ConnectionTrackingSpecification": { "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", "traits": { - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Connection tracking timeouts in the\n Amazon EC2 User Guide.
" + } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The number of ENA queues to be created with the instance.
" } } }, @@ -66017,7 +66373,7 @@ "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", "traits": { "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "The association information for an Elastic IP address for the network interface.
", + "smithy.api#documentation": "The association information for an Elastic IP address for the network\n interface.
", "smithy.api#xmlName": "association" } }, @@ -66025,7 +66381,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Primary", - "smithy.api#documentation": "Indicates whether this IPv4 address is the primary private IP address of the network interface.
", + "smithy.api#documentation": "Indicates whether this IPv4 address is the primary private IP address of the network\n interface.
", "smithy.api#xmlName": "primary" } }, @@ -66059,6 +66415,23 @@ } } }, + "com.amazonaws.ec2#InstanceRebootMigrationState": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "default" + } + } + } + }, "com.amazonaws.ec2#InstanceRequirements": { "type": "structure", "members": { @@ -72370,7 +72743,7 @@ "target": "com.amazonaws.ec2#UsageClassTypeList", "traits": { "aws.protocols#ec2QueryName": "SupportedUsageClasses", - "smithy.api#documentation": "Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.
", + "smithy.api#documentation": "Indicates whether the instance type is offered for spot, On-Demand, or Capacity\n Blocks.
", "smithy.api#xmlName": "supportedUsageClasses" } }, @@ -72581,6 +72954,14 @@ "smithy.api#documentation": "Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is\n supported.
", "smithy.api#xmlName": "phcSupport" } + }, + "RebootMigrationSupport": { + "target": "com.amazonaws.ec2#RebootMigrationSupport", + "traits": { + "aws.protocols#ec2QueryName": "RebootMigrationSupport", + "smithy.api#documentation": "Indicates whether reboot migration during a user-initiated reboot is supported for\n instances that have a scheduled system-reboot event. For more information,\n see Enable or disable reboot migration in the\n Amazon EC2 User Guide.
Information about the IPv4 delegated prefixes assigned \n to a network interface.
" + "smithy.api#documentation": "Information about the IPv4 delegated prefixes assigned to a network interface.
" } }, "com.amazonaws.ec2#Ipv4PrefixesList": { @@ -76270,7 +76651,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the IPv6 delegated prefixes assigned \n to a network interface.
" + "smithy.api#documentation": "Information about the IPv6 delegated prefixes assigned to a network interface.
" } }, "com.amazonaws.ec2#Ipv6PrefixesList": { @@ -77121,7 +77502,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.
", + "smithy.api#documentation": "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
", "smithy.api#xmlName": "kmsKeyId" } }, @@ -77156,6 +77537,14 @@ "smithy.api#documentation": "The throughput that the volume supports, in MiB/s.
", "smithy.api#xmlName": "throughput" } + }, + "VolumeInitializationRate": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeInitializationRate", + "smithy.api#documentation": "The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. \n If no volume initialization rate was specified, the value is null.
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.
" + "smithy.api#documentation": "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
" } }, "SnapshotId": { @@ -77212,6 +77601,12 @@ "traits": { "smithy.api#documentation": "The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" } + }, + "VolumeInitializationRate": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download \n the snapshot blocks from Amazon S3 to the volume. This is also known as volume \n initialization. Specifying a volume initialization rate ensures that the volume is \n initialized at a predictable and consistent rate after creation.
\nThis parameter is supported only for volumes created from snapshots. Omit this parameter \n if:
\nYou want to create the volume using fast snapshot restore. You must specify a snapshot \n that is enabled for fast snapshot restore. In this case, the volume is fully initialized \n at creation.
\nIf you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, \n the volume will be initialized at the specified rate instead of fast snapshot restore.
\nYou want to create a volume that is initialized at the default rate.
\nFor more information, see \n Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
\nValid range: 100 - 300 MiB/s
" + } } }, "traits": { @@ -77610,7 +78005,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", "traits": { "aws.protocols#ec2QueryName": "HttpTokens", - "smithy.api#documentation": "Indicates whether IMDSv2 is required.
\n\n optional - IMDSv2 is optional. You can choose whether to send a \n session token in your instance metadata retrieval requests. If you retrieve \n IAM role credentials without a session token, you receive the IMDSv1 role \n credentials. If you retrieve IAM role credentials using a valid session token, \n you receive the IMDSv2 role credentials.
\n required - IMDSv2 is required. You must send a session token \n in your instance metadata retrieval requests. With this option, retrieving the \n IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are \n not available.
Indicates whether IMDSv2 is required.
\n\n optional - IMDSv2 is optional. You can choose whether to send a\n session token in your instance metadata retrieval requests. If you retrieve IAM\n role credentials without a session token, you receive the IMDSv1 role\n credentials. If you retrieve IAM role credentials using a valid session token,\n you receive the IMDSv2 role credentials.
\n required - IMDSv2 is required. You must send a session token in\n your instance metadata retrieval requests. With this option, retrieving the IAM\n role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not\n available.
Indicates whether IMDSv2 is required.
\n\n optional - IMDSv2 is optional. You can choose whether to send a \n session token in your instance metadata retrieval requests. If you retrieve \n IAM role credentials without a session token, you receive the IMDSv1 role \n credentials. If you retrieve IAM role credentials using a valid session token, \n you receive the IMDSv2 role credentials.
\n required - IMDSv2 is required. You must send a session token \n in your instance metadata retrieval requests. With this option, retrieving the \n IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are \n not available.
Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) \n for your instance is v2.0, the default is required.
Indicates whether IMDSv2 is required.
\n\n optional - IMDSv2 is optional. You can choose whether to send a\n session token in your instance metadata retrieval requests. If you retrieve IAM\n role credentials without a session token, you receive the IMDSv1 role\n credentials. If you retrieve IAM role credentials using a valid session token,\n you receive the IMDSv2 role credentials.
\n required - IMDSv2 is required. You must send a session token in\n your instance metadata retrieval requests. With this option, retrieving the IAM\n role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not\n available.
Default: If the value of ImdsSupport for the Amazon Machine Image (AMI)\n for your instance is v2.0, the default is required.
The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
", + "smithy.api#documentation": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address\n to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the\n instance is terminated or the network interface is detached. For more information about\n primary IPv6 addresses, see RunInstances.
", "smithy.api#xmlName": "primaryIpv6" } }, @@ -77907,7 +78302,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateEnaSrdSpecification", "traits": { "aws.protocols#ec2QueryName": "EnaSrdSpecification", - "smithy.api#documentation": "Contains the ENA Express settings for instances launched from your launch template.
", + "smithy.api#documentation": "Contains the ENA Express settings for instances launched from your launch\n template.
", "smithy.api#xmlName": "enaSrdSpecification" } }, @@ -77915,9 +78310,17 @@ "target": "com.amazonaws.ec2#ConnectionTrackingSpecification", "traits": { "aws.protocols#ec2QueryName": "ConnectionTrackingSpecification", - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingSpecification" } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnaQueueCount", + "smithy.api#documentation": "The number of ENA queues created with the instance.
", + "smithy.api#xmlName": "enaQueueCount" + } } }, "traits": { @@ -77963,7 +78366,7 @@ "DeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The device index for the network interface attachment. The primary network interface\n has a device index of 0. Each network interface is of type interface, you\n must specify a device index. If you create a launch template that includes secondary \n network interfaces but not a primary network interface, then you must add a primary \n network interface as a launch parameter when you launch an instance from the template.
The device index for the network interface attachment. The primary network interface\n has a device index of 0. Each network interface is of type interface, you\n must specify a device index. If you create a launch template that includes secondary\n network interfaces but not a primary network interface, then you must add a primary\n network interface as a launch parameter when you launch an instance from the\n template.
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa or efa. For more information, see Elastic Fabric Adapter for AI/ML\n and HPC workloads on Amazon EC2 in the\n Amazon EC2 User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa or efa. For more information, see Elastic Fabric Adapter for AI/ML\n and HPC workloads on Amazon EC2 in the\n Amazon EC2 User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
If you specify efa-only, do not assign any IP addresses to the network\n interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
" + "smithy.api#documentation": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address\n to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the\n instance is terminated or the network interface is detached. For more information about\n primary IPv6 addresses, see RunInstances.
" } }, "EnaSrdSpecification": { @@ -78068,7 +78471,13 @@ "ConnectionTrackingSpecification": { "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", "traits": { - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
" + } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The number of ENA queues to be created with the instance.
" } } }, @@ -78159,13 +78568,13 @@ "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", "traits": { "aws.protocols#ec2QueryName": "BandwidthWeighting", - "smithy.api#documentation": "When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking \n \t\tor EBS by up to 25%. The total available baseline bandwidth for your instance remains \n the same. The default option uses the standard bandwidth configuration for your instance type.
", + "smithy.api#documentation": "When you configure network bandwidth weighting, you can boost baseline bandwidth for\n either networking or EBS by up to 25%. The total available baseline bandwidth for your\n instance remains the same. The default option uses the standard bandwidth configuration\n for your instance type.
", "smithy.api#xmlName": "bandwidthWeighting" } } }, "traits": { - "smithy.api#documentation": "With network performance options, you can adjust your bandwidth preferences to meet \n \t\tthe needs of the workload that runs on your instance at launch.
" + "smithy.api#documentation": "With network performance options, you can adjust your bandwidth preferences to meet\n the needs of the workload that runs on your instance at launch.
" } }, "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptionsRequest": { @@ -78174,12 +78583,12 @@ "BandwidthWeighting": { "target": "com.amazonaws.ec2#InstanceBandwidthWeighting", "traits": { - "smithy.api#documentation": "Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:
\nThis option uses the standard bandwidth configuration for your instance type.
\nThis option boosts your networking baseline bandwidth and reduces your EBS \n \t\t\t\t\tbaseline bandwidth.
\nThis option boosts your EBS baseline bandwidth and reduces your networking \n \t\t\t\t\tbaseline bandwidth.
\nSpecify the bandwidth weighting option to boost the associated type of baseline\n bandwidth, as follows:
\nThis option uses the standard bandwidth configuration for your instance\n type.
\nThis option boosts your networking baseline bandwidth and reduces your EBS\n baseline bandwidth.
\nThis option boosts your EBS baseline bandwidth and reduces your networking\n baseline bandwidth.
\nWhen you configure network performance options in your launch template, your instance \n \t\tis geared for performance improvements based on the workload that it runs as soon as it's \n \t\tavailable.
" + "smithy.api#documentation": "When you configure network performance options in your launch template, your instance\n is geared for performance improvements based on the workload that it runs as soon as\n it's available.
" } }, "com.amazonaws.ec2#LaunchTemplateOverrides": { @@ -78294,7 +78703,7 @@ "target": "com.amazonaws.ec2#Tenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.
The tenancy of the instance. An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The tenancy of the instance. An instance with a\n tenancy of dedicated runs on single-tenant hardware.
" + "smithy.api#documentation": "The tenancy of the instance. An instance with a tenancy of dedicated runs on\n single-tenant hardware.
" } }, "SpreadDomain": { @@ -78615,7 +79024,7 @@ "ResourceType": { "target": "com.amazonaws.ec2#ResourceType", "traits": { - "smithy.api#documentation": "The type of resource to tag.
\nValid Values lists all resource types for Amazon EC2 that can be tagged. When\n you create a launch template, you can specify tags for the following resource types\n only: instance | volume |\n network-interface | spot-instances-request.\n If the instance does not include the resource type that you specify, the instance \n launch fails. For example, not all instance types include a volume.
To tag a resource after it has been created, see CreateTags.
" + "smithy.api#documentation": "The type of resource to tag.
\nValid Values lists all resource types for Amazon EC2 that can be tagged. When you\n create a launch template, you can specify tags for the following resource types only:\n instance | volume |\n network-interface | spot-instances-request. If the instance\n does not include the resource type that you specify, the instance launch fails. For\n example, not all instance types include a volume.
To tag a resource after it has been created, see CreateTags.
" } }, "Tags": { @@ -80393,6 +80802,137 @@ } } }, + "com.amazonaws.ec2#MacModificationTask": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "The ID of the Amazon EC2 Mac instance.
", + "smithy.api#xmlName": "instanceId" + } + }, + "MacModificationTaskId": { + "target": "com.amazonaws.ec2#MacModificationTaskId", + "traits": { + "aws.protocols#ec2QueryName": "MacModificationTaskId", + "smithy.api#documentation": "The ID of task.
", + "smithy.api#xmlName": "macModificationTaskId" + } + }, + "MacSystemIntegrityProtectionConfig": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "MacSystemIntegrityProtectionConfig", + "smithy.api#documentation": "[SIP modification tasks only] Information about the SIP \n configuration.
", + "smithy.api#xmlName": "macSystemIntegrityProtectionConfig" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "The date and time the task was created, in the UTC timezone \n (YYYY-MM-DDThh:mm:ss.sssZ).
The tags assigned to the task.
", + "smithy.api#xmlName": "tagSet" + } + }, + "TaskState": { + "target": "com.amazonaws.ec2#MacModificationTaskState", + "traits": { + "aws.protocols#ec2QueryName": "TaskState", + "smithy.api#documentation": "The state of the task.
", + "smithy.api#xmlName": "taskState" + } + }, + "TaskType": { + "target": "com.amazonaws.ec2#MacModificationTaskType", + "traits": { + "aws.protocols#ec2QueryName": "TaskType", + "smithy.api#documentation": "The type of task.
", + "smithy.api#xmlName": "taskType" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a System Integrity Protection (SIP) modification task or volume \n ownership delegation task for an Amazon EC2 Mac instance.
" + } + }, + "com.amazonaws.ec2#MacModificationTaskId": { + "type": "string" + }, + "com.amazonaws.ec2#MacModificationTaskIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MacModificationTaskId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MacModificationTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MacModificationTask", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MacModificationTaskState": { + "type": "enum", + "members": { + "successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "successful" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "inprogress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-progress" + } + }, + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + } + } + }, + "com.amazonaws.ec2#MacModificationTaskType": { + "type": "enum", + "members": { + "SIPModification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sip-modification" + } + }, + "VolumeOwnershipDelegation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "volume-ownership-delegation" + } + } + } + }, "com.amazonaws.ec2#MacOSVersionStringList": { "type": "list", "member": { @@ -80402,6 +80942,145 @@ } } }, + "com.amazonaws.ec2#MacSystemIntegrityProtectionConfiguration": { + "type": "structure", + "members": { + "AppleInternal": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "AppleInternal", + "smithy.api#documentation": "Indicates whether Apple Internal was enabled or disabled by the task.
", + "smithy.api#xmlName": "appleInternal" + } + }, + "BaseSystem": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "BaseSystem", + "smithy.api#documentation": "Indicates whether Base System was enabled or disabled by the task.
", + "smithy.api#xmlName": "baseSystem" + } + }, + "DebuggingRestrictions": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "DebuggingRestrictions", + "smithy.api#documentation": "Indicates whether Debugging Restrictions was enabled or disabled by the task.
", + "smithy.api#xmlName": "debuggingRestrictions" + } + }, + "DTraceRestrictions": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "DTraceRestrictions", + "smithy.api#documentation": "Indicates whether Dtrace Restrictions was enabled or disabled by the task.
", + "smithy.api#xmlName": "dTraceRestrictions" + } + }, + "FilesystemProtections": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "FilesystemProtections", + "smithy.api#documentation": "Indicates whether Filesystem Protections was enabled or disabled by the task.
", + "smithy.api#xmlName": "filesystemProtections" + } + }, + "KextSigning": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "KextSigning", + "smithy.api#documentation": "Indicates whether Kext Signing was enabled or disabled by the task.
", + "smithy.api#xmlName": "kextSigning" + } + }, + "NvramProtections": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "NvramProtections", + "smithy.api#documentation": "Indicates whether NVRAM Protections was enabled or disabled by the task.
", + "smithy.api#xmlName": "nvramProtections" + } + }, + "Status": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "Indicates SIP was enabled or disabled by the task.
", + "smithy.api#xmlName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for a System Integrity Protection (SIP) modification task.
" + } + }, + "com.amazonaws.ec2#MacSystemIntegrityProtectionConfigurationRequest": { + "type": "structure", + "members": { + "AppleInternal": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Apple Internal.
" + } + }, + "BaseSystem": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Base System.
" + } + }, + "DebuggingRestrictions": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Debugging Restrictions.
" + } + }, + "DTraceRestrictions": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Dtrace Restrictions.
" + } + }, + "FilesystemProtections": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Filesystem Protections.
" + } + }, + "KextSigning": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Kext Signing.
" + } + }, + "NvramProtections": { + "target": "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus", + "traits": { + "smithy.api#documentation": "Enables or disables Nvram Protections.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a custom configuration for a System Integrity Protection (SIP) modification task.
" + } + }, + "com.amazonaws.ec2#MacSystemIntegrityProtectionSettingStatus": { + "type": "enum", + "members": { + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, "com.amazonaws.ec2#MaintenanceDetails": { "type": "structure", "members": { @@ -80601,6 +81280,12 @@ "com.amazonaws.ec2#MaximumEfaInterfaces": { "type": "integer" }, + "com.amazonaws.ec2#MaximumEnaQueueCount": { + "type": "integer" + }, + "com.amazonaws.ec2#MaximumEnaQueueCountPerInterface": { + "type": "integer" + }, "com.amazonaws.ec2#MaximumIops": { "type": "integer" }, @@ -81318,7 +82003,7 @@ "DisconnectOnSessionTimeout": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Modifies the recovery behavior of your instance to disable simplified automatic\n recovery or set the recovery behavior to default. The default configuration will not\n enable simplified automatic recovery for an unsupported instance type. For more\n information, see Simplified automatic recovery.
" + "smithy.api#documentation": "Modifies the recovery behavior of your instance to disable simplified automatic\n recovery or set the recovery behavior to default. The default configuration will not\n enable simplified automatic recovery for an unsupported instance type. For more\n information, see Simplified automatic recovery.
\nModifies the reboot migration behavior during a user-initiated reboot of an instance\n that has a pending system-reboot event. For more information, see Enable or disable reboot migration.
Disables the automatic recovery behavior of your instance or sets it to\n default.
" } }, + "RebootMigration": { + "target": "com.amazonaws.ec2#InstanceRebootMigrationState", + "traits": { + "smithy.api#documentation": "Specifies whether to attempt reboot migration during a user-initiated reboot of an\n instance that has a scheduled system-reboot event:
\n default - Amazon EC2 attempts to migrate the instance to\n new hardware (reboot migration). If successful, the system-reboot\n event is cleared. If unsuccessful, an in-place reboot occurs and the event\n remains scheduled.
\n disabled - Amazon EC2 keeps the instance on the same\n hardware (in-place reboot). The system-reboot event remains\n scheduled.
This setting only applies to supported instances that have a scheduled reboot event.\n For more information, see Enable or disable reboot migration in the\n Amazon EC2 User Guide.
" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -82513,6 +83204,14 @@ "smithy.api#documentation": "Provides information on the current automatic recovery behavior of your\n instance.
", "smithy.api#xmlName": "autoRecovery" } + }, + "RebootMigration": { + "target": "com.amazonaws.ec2#InstanceRebootMigrationState", + "traits": { + "aws.protocols#ec2QueryName": "RebootMigration", + "smithy.api#documentation": "Specifies whether to attempt reboot migration during a user-initiated reboot of an\n instance that has a scheduled system-reboot event:
\n default - Amazon EC2 attempts to migrate the instance to\n new hardware (reboot migration). If successful, the system-reboot\n event is cleared. If unsuccessful, an in-place reboot occurs and the event\n remains scheduled.
\n disabled - Amazon EC2 keeps the instance on the same\n hardware (in-place reboot). The system-reboot event remains\n scheduled.
This setting only applies to supported instances that have a scheduled reboot event.\n For more information, see Enable or disable reboot migration in the\n Amazon EC2 User Guide.
", + "smithy.api#xmlName": "rebootMigration" + } } }, "traits": { @@ -83293,20 +83992,20 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If a client token isn't specified, a randomly generated token is used in the\n request to ensure idempotency.
\nFor more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
", "smithy.api#idempotencyToken": {} } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the\n launch template name, but not both.
" + "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template ID or the launch template name, but not\n both.
" } }, "DefaultVersion": { @@ -83502,7 +84201,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.
", + "smithy.api#documentation": "Modifies the specified network interface attribute. You can specify only one attribute\n at a time. You can use this action to attach and detach security groups from an existing\n EC2 instance.
", "smithy.api#examples": [ { "title": "To modify the attachment attribute of a network interface", @@ -83555,7 +84254,7 @@ "EnaSrdSpecification": { "target": "com.amazonaws.ec2#EnaSrdSpecification", "traits": { - "smithy.api#documentation": "Updates the ENA Express configuration for the network interface that\u2019s attached to the\n\t\t\tinstance.
" + "smithy.api#documentation": "Updates the ENA Express configuration for the network interface that\u2019s attached to the\n instance.
" } }, "EnablePrimaryIpv6": { @@ -83573,14 +84272,14 @@ "AssociatePublicIpAddress": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
" + "smithy.api#documentation": "Indicates whether to assign a public IPv4 address to a network interface. This option\n can be enabled for any network interface but will only apply to the primary network\n interface (eth0).
" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Enable or disable source/destination checks, which ensure that the instance\n is either the source or the destination of any traffic that it receives.\n If the value is true, source/destination checks are enabled;\n otherwise, they are disabled. The default value is true. \n You must disable source/destination checks if the instance runs services \n such as network address translation, routing, or firewalls.
Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", + "smithy.api#documentation": "Changes the security groups for the network interface. The new set of groups you\n specify replaces the current set. You must specify at least one group, even if it's just\n the default security group in the VPC. You must specify the ID of the security group,\n not the name.
", "smithy.api#xmlName": "SecurityGroupId" } }, @@ -83621,7 +84320,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", "traits": { "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.
Information about the interface attachment. If modifying the delete on\n termination attribute, you must specify the ID of the interface\n attachment.
Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the configuration of your Reserved Instances, such as the Availability Zone,\n instance count, or instance type. The Reserved Instances to be modified must be identical,\n except for Availability Zone, network platform, and instance type.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyReservedInstancesRequest": { @@ -83727,7 +84426,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see \n \t\tEnsuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token you provide to ensure idempotency of your modification\n request. For more information, see Ensuring\n Idempotency.
", "smithy.api#xmlName": "clientToken" } }, @@ -87983,6 +88682,30 @@ "smithy.api#documentation": "The peak (burst) network performance of the network card, in Gbps.
", "smithy.api#xmlName": "peakBandwidthInGbps" } + }, + "DefaultEnaQueueCountPerInterface": { + "target": "com.amazonaws.ec2#DefaultEnaQueueCountPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "DefaultEnaQueueCountPerInterface", + "smithy.api#documentation": "The default number of the ENA queues for each interface.
", + "smithy.api#xmlName": "defaultEnaQueueCountPerInterface" + } + }, + "MaximumEnaQueueCount": { + "target": "com.amazonaws.ec2#MaximumEnaQueueCount", + "traits": { + "aws.protocols#ec2QueryName": "MaximumEnaQueueCount", + "smithy.api#documentation": "The maximum number of the ENA queues.
", + "smithy.api#xmlName": "maximumEnaQueueCount" + } + }, + "MaximumEnaQueueCountPerInterface": { + "target": "com.amazonaws.ec2#MaximumEnaQueueCountPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "MaximumEnaQueueCountPerInterface", + "smithy.api#documentation": "The maximum number of the ENA queues for each interface.
", + "smithy.api#xmlName": "maximumEnaQueueCountPerInterface" + } } }, "traits": { @@ -88109,9 +88832,17 @@ "target": "com.amazonaws.ec2#BandwidthWeightingTypeList", "traits": { "aws.protocols#ec2QueryName": "BandwidthWeightings", - "smithy.api#documentation": "A list of valid settings for configurable bandwidth weighting for the instance\n \ttype, if supported.
", + "smithy.api#documentation": "A list of valid settings for configurable bandwidth weighting for the instance type, if\n supported.
", "smithy.api#xmlName": "bandwidthWeightings" } + }, + "FlexibleEnaQueuesSupport": { + "target": "com.amazonaws.ec2#FlexibleEnaQueuesSupport", + "traits": { + "aws.protocols#ec2QueryName": "FlexibleEnaQueuesSupport", + "smithy.api#documentation": "Indicates whether changing the number of ENA queues is supported.
", + "smithy.api#xmlName": "flexibleEnaQueuesSupport" + } } }, "traits": { @@ -88379,6 +89110,14 @@ "smithy.api#xmlName": "filterInArnSet" } }, + "FilterOutArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "aws.protocols#ec2QueryName": "FilterOutArnSet", + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the resources that the path must ignore.
", + "smithy.api#xmlName": "filterOutArnSet" + } + }, "StartDate": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { @@ -88653,7 +89392,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", "traits": { "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "The association information for an Elastic IP address (IPv4) associated with the network interface.
", + "smithy.api#documentation": "The association information for an Elastic IP address (IPv4) associated with the\n network interface.
", "smithy.api#xmlName": "association" } }, @@ -88677,7 +89416,7 @@ "target": "com.amazonaws.ec2#ConnectionTrackingConfiguration", "traits": { "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", - "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Connection tracking timeouts in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingConfiguration" } }, @@ -88789,7 +89528,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "The alias or Amazon Web Services account ID of the principal or service that created the network interface.
", + "smithy.api#documentation": "The alias or Amazon Web Services account ID of the principal or service that created\n the network interface.
", "smithy.api#xmlName": "requesterId" } }, @@ -88845,7 +89584,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DenyAllIgwTraffic", - "smithy.api#documentation": "Indicates whether a network interface with an IPv6 address is unreachable from the \n public internet. If the value is true, inbound traffic from the internet \n is dropped and you cannot assign an elastic IP address to the network interface. The \n network interface is reachable from peered VPCs and resources connected through a \n transit gateway, including on-premises networks.
Indicates whether a network interface with an IPv6 address is unreachable from the\n public internet. If the value is true, inbound traffic from the internet is\n dropped and you cannot assign an elastic IP address to the network interface. The\n network interface is reachable from peered VPCs and resources connected through a\n transit gateway, including on-premises networks.
The address of the Elastic IP address bound to the network\n interface.
", + "smithy.api#documentation": "The address of the Elastic IP address bound to the network interface.
", "smithy.api#xmlName": "publicIp" } }, @@ -88933,7 +89672,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "The carrier IP address associated with the network interface.
\nThis option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
", + "smithy.api#documentation": "The carrier IP address associated with the network interface.
\nThis option is only available when the network interface is in a subnet which is\n associated with a Wavelength Zone.
", "smithy.api#xmlName": "carrierIp" } } @@ -88965,7 +89704,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", + "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is\n terminated.
", "smithy.api#xmlName": "deleteOnTermination" } }, @@ -89013,9 +89752,17 @@ "target": "com.amazonaws.ec2#AttachmentEnaSrdSpecification", "traits": { "aws.protocols#ec2QueryName": "EnaSrdSpecification", - "smithy.api#documentation": "Configures ENA Express for the network interface that this action attaches to the instance.
", + "smithy.api#documentation": "Configures ENA Express for the network interface that this action attaches to the\n instance.
", "smithy.api#xmlName": "enaSrdSpecification" } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "EnaQueueCount", + "smithy.api#documentation": "The number of ENA queues created with the instance.
", + "smithy.api#xmlName": "enaQueueCount" + } } }, "traits": { @@ -89025,6 +89772,18 @@ "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges": { "type": "structure", "members": { + "DefaultEnaQueueCount": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "The default number of the ENA queues.
" + } + }, + "EnaQueueCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The number of ENA queues to be created with the instance.
" + } + }, "AttachmentId": { "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", "traits": { @@ -89037,7 +89796,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", + "smithy.api#documentation": "Indicates whether the network interface is deleted when the instance is\n terminated.
", "smithy.api#xmlName": "deleteOnTermination" } } @@ -89193,7 +89952,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "IsPrimaryIpv6", - "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. \n For more information, see ModifyNetworkInterfaceAttribute.
", + "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6\n address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA\n will be made the primary IPv6 address until the instance is terminated or the network\n interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
", "smithy.api#xmlName": "isPrimaryIpv6" } } @@ -89354,7 +90113,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", "traits": { "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "The association information for an Elastic IP address (IPv4) associated with the network interface.
", + "smithy.api#documentation": "The association information for an Elastic IP address (IPv4) associated with the\n network interface.
", "smithy.api#xmlName": "association" } }, @@ -89362,7 +90121,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Primary", - "smithy.api#documentation": "Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
", + "smithy.api#documentation": "Indicates whether this IPv4 address is the primary private IPv4 address of the network\n interface.
", "smithy.api#xmlName": "primary" } }, @@ -91913,7 +92672,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Active", - "smithy.api#documentation": "The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
\nA specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
", + "smithy.api#documentation": "The current price schedule, as determined by the term remaining for the Reserved Instance\n in the listing.
\nA specific price schedule is always in effect, but only one price schedule can be active\n at any time. Take, for example, a Reserved Instance listing that has five months remaining in\n its term. When you specify price schedules for five months and two months, this means that\n schedule 1, covering the first three months of the remaining term, will be active during\n months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active\n for months 2 and 1.
", "smithy.api#xmlName": "active" } }, @@ -91921,7 +92680,7 @@ "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The currency for transacting the Reserved Instance resale. At this time, the only\n supported currency is USD.
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", + "smithy.api#documentation": "The number of months remaining in the reservation. For example, 2 is the second to the\n last month before the capacity reservation expires.
", "smithy.api#xmlName": "term" } } @@ -91962,7 +92721,7 @@ "target": "com.amazonaws.ec2#Long", "traits": { "aws.protocols#ec2QueryName": "Term", - "smithy.api#documentation": "The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", + "smithy.api#documentation": "The number of months remaining in the reservation. For example, 2 is the second to the\n last month before the capacity reservation expires.
", "smithy.api#xmlName": "term" } }, @@ -91978,7 +92737,7 @@ "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The currency for transacting the Reserved Instance resale. At this time, the only\n supported currency is USD.
Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\nUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\nFor more information, see Reserved\n Instances and Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay\n a lower hourly rate compared to On-Demand instance pricing.
\nUse DescribeReservedInstancesOfferings to get a list of Reserved\n Instance offerings that match your specifications. After you've purchased a Reserved Instance,\n you can check for your new Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not\n specify a purchase time, the default is the current time.
\nFor more information, see Reserved\n Instances and Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { @@ -93434,14 +94193,14 @@ "PurchaseTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
" + "smithy.api#documentation": "The time at which to purchase the Reserved Instance, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).
" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the error\n response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
", + "smithy.api#documentation": "Specified for Reserved Instance Marketplace offerings to limit the total order and ensure\n that the Reserved Instances are not purchased at unexpected prices.
", "smithy.api#xmlName": "limitPrice" } } @@ -93466,7 +94225,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "reservedInstancesId" } } @@ -93653,6 +94412,23 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#RebootMigrationSupport": { + "type": "enum", + "members": { + "UNSUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unsupported" + } + }, + "SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "supported" + } + } + } + }, "com.amazonaws.ec2#RecurringCharge": { "type": "structure", "members": { @@ -95947,7 +96723,7 @@ "ImageId": { "target": "com.amazonaws.ec2#ImageId", "traits": { - "smithy.api#documentation": "The ID of the AMI in the format ami-0ac394d6a3example.
Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.
\nTo reference a public parameter:
\n\n resolve:ssm:public-parameter\n \n
To reference a parameter stored in the same account:
\n\n resolve:ssm:parameter-name\n \n
\n resolve:ssm:parameter-name:version-number\n \n
\n resolve:ssm:parameter-name:label\n \n
To reference a parameter shared from another Amazon Web Services account:
\n\n resolve:ssm:parameter-ARN\n \n
\n resolve:ssm:parameter-ARN:version-number\n \n
\n resolve:ssm:parameter-ARN:label\n \n
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
\nIf the launch template will be used for an EC2 Fleet or Spot Fleet, note the\n following:
\nOnly EC2 Fleets of type instant support specifying a Systems\n Manager parameter.
For EC2 Fleets of type maintain or request, or\n for Spot Fleets, you must specify the AMI ID.
The ID of the AMI in the format ami-0ac394d6a3example.
Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.
\nTo reference a public parameter:
\n\n resolve:ssm:public-parameter\n \n
To reference a parameter stored in the same account:
\n\n resolve:ssm:parameter-name\n \n
\n resolve:ssm:parameter-name:version-number\n \n
\n resolve:ssm:parameter-name:label\n \n
To reference a parameter shared from another Amazon Web Services account:
\n\n resolve:ssm:parameter-ARN\n \n
\n resolve:ssm:parameter-ARN:version-number\n \n
\n resolve:ssm:parameter-ARN:label\n \n
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
\nIf the launch template will be used for an EC2 Fleet or Spot Fleet, note the\n following:
\nOnly EC2 Fleets of type instant support specifying a Systems\n Manager parameter.
For EC2 Fleets of type maintain or request, or\n for Spot Fleets, you must specify the AMI ID.
Indicates whether termination protection is enabled for the instance. The default\n is false, which means that you can terminate the instance using\n the Amazon EC2 console, command line tools, or API. You can enable termination protection\n when you launch an instance, while the instance is running, or while the instance\n is stopped.
Indicates whether termination protection is enabled for the instance. The default is\n false, which means that you can terminate the instance using the Amazon EC2\n console, command line tools, or API. You can enable termination protection when you\n launch an instance, while the instance is running, or while the instance is\n stopped.
The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands when you launch an EC2\n instance with user data input in the\n Amazon EC2 User Guide.
\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" + "smithy.api#documentation": "The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands when you launch an EC2\n instance with user data input in the\n Amazon EC2 User Guide.
\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the\n Batch User Guide.
" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", "traits": { - "smithy.api#documentation": "The tags to apply to the resources that are created during instance launch. These\n tags are not applied to the launch template.
", + "smithy.api#documentation": "The tags to apply to the resources that are created during instance launch. These tags\n are not applied to the launch template.
", "smithy.api#xmlName": "TagSpecification" } }, @@ -96022,14 +96798,14 @@ "SecurityGroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the security groups.
\nIf you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.
", + "smithy.api#documentation": "The IDs of the security groups.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.
", "smithy.api#xmlName": "SecurityGroupId" } }, "SecurityGroups": { "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "The names of the security groups. For a nondefault VPC, you must use security group\n IDs instead.
\nIf you specify a network interface, you must specify any security groups as part of \n the network interface instead of using this parameter.
", + "smithy.api#documentation": "The names of the security groups. For a nondefault VPC, you must use security group\n IDs instead.
\nIf you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.
", "smithy.api#xmlName": "SecurityGroup" } }, @@ -96073,7 +96849,7 @@ "MetadataOptions": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest", "traits": { - "smithy.api#documentation": "The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "The metadata options for the instance. For more information, see Configure\n the Instance Metadata Service options in the\n Amazon EC2 User Guide.
" } }, "EnclaveOptions": { @@ -96115,7 +96891,7 @@ "NetworkPerformanceOptions": { "target": "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptionsRequest", "traits": { - "smithy.api#documentation": "Contains launch template settings to boost network performance for the type of \n \tworkload that runs on your instance.
" + "smithy.api#documentation": "Contains launch template settings to boost network performance for the type of\n workload that runs on your instance.
" } } }, @@ -96802,7 +97578,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "RemainingTotalValue", - "smithy.api#documentation": "The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
", + "smithy.api#documentation": "The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of\n hours remaining).
", "smithy.api#xmlName": "remainingTotalValue" } }, @@ -96835,7 +97611,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "Amount", - "smithy.api#documentation": "Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
", + "smithy.api#documentation": "Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total\n order (instanceCount * price).
", "smithy.api#xmlName": "amount" } }, @@ -96843,7 +97619,7 @@ "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.
The currency in which the limitPrice amount is specified. At this time, the\n only supported currency is USD.
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency\n codes. At this time, the only supported currency is USD.
The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "ReservedInstancesId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -97117,9 +97901,17 @@ "target": "com.amazonaws.ec2#scope", "traits": { "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
", + "smithy.api#documentation": "Whether the Reserved Instance is applied to instances in a Region or instances in a\n specific Availability Zone.
", "smithy.api#xmlName": "scope" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } } }, "traits": { @@ -97176,7 +97968,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is\n idempotent. For more information, see Ensuring\n Idempotency.
", "smithy.api#xmlName": "clientToken" } }, @@ -97232,7 +98024,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "The reason for the current status of the Reserved Instance listing. The response can be blank.
", + "smithy.api#documentation": "The reason for the current status of the Reserved Instance listing. The response can be\n blank.
", "smithy.api#xmlName": "statusMessage" } }, @@ -97276,7 +98068,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is idempotent.\n\t\t\tFor more information, see Ensuring\n\t\t\t\tIdempotency.
", + "smithy.api#documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is\n idempotent. For more information, see Ensuring\n Idempotency.
", "smithy.api#xmlName": "clientToken" } }, @@ -97300,7 +98092,7 @@ "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", "traits": { "aws.protocols#ec2QueryName": "ModificationResultSet", - "smithy.api#documentation": "Contains target configurations along with their corresponding new Reserved Instance IDs.
", + "smithy.api#documentation": "Contains target configurations along with their corresponding new Reserved Instance\n IDs.
", "smithy.api#xmlName": "modificationResultSet" } }, @@ -97377,7 +98169,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
", + "smithy.api#documentation": "The ID for the Reserved Instances that were created as part of the modification request.\n This field is only available when the modification is fulfilled.
", "smithy.api#xmlName": "reservedInstancesId" } }, @@ -97385,7 +98177,7 @@ "target": "com.amazonaws.ec2#ReservedInstancesConfiguration", "traits": { "aws.protocols#ec2QueryName": "TargetConfiguration", - "smithy.api#documentation": "The target Reserved Instances configurations supplied as part of the modification request.
", + "smithy.api#documentation": "The target Reserved Instances configurations supplied as part of the modification\n request.
", "smithy.api#xmlName": "targetConfiguration" } } @@ -97410,7 +98202,7 @@ "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.
The currency of the Reserved Instance offering you are purchasing. It's specified using\n ISO 4217 standard currency codes. At this time, the only supported currency is\n USD.
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. \n If it's a Reserved Instance Marketplace offering, this is true.
Indicates whether the offering is available through the Reserved Instance Marketplace\n (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is\n true.
If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.
If convertible it can be exchanged for Reserved Instances of the same or\n higher monetary value, with different configurations. If standard, it is not\n possible to perform an exchange.
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
", + "smithy.api#documentation": "Whether the Reserved Instance is applied to instances in a Region or an Availability\n Zone.
", "smithy.api#xmlName": "scope" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "ReservedInstancesOfferingId": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", - "smithy.api#documentation": "The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.
", + "smithy.api#documentation": "The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be\n made.
", "smithy.api#xmlName": "reservedInstancesOfferingId" } }, @@ -97860,7 +98660,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Resets a network interface attribute. You can specify only one attribute at a time.
" + "smithy.api#documentation": "Resets a network interface attribute. You can specify only one attribute at a\n time.
" } }, "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest": { @@ -97870,7 +98670,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.
The source/destination checking attribute. Resets the value to true.
The source/destination checking attribute. Resets the value to\n true.
The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.
\nThe value depends on what you specified in the request. The possible values are:
\nIf an AMI ID was specified in the request, then this is the AMI ID.
\nIf a Systems Manager parameter was specified in the request, and\n ResolveAlias was configured as true, then this is\n the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and ResolveAlias was configured\n as false, then this is the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.
\nThe value depends on what you specified in the request. The possible values\n are:
\nIf an AMI ID was specified in the request, then this is the AMI ID.
\nIf a Systems Manager parameter was specified in the request, and\n ResolveAlias was configured as true, then this is\n the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and\n ResolveAlias was configured as false, then this is\n the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "imageId" } }, @@ -98844,7 +99650,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", "traits": { "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "The metadata options for the instance. For more information, see Configure\n the Instance Metadata Service options in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "metadataOptions" } }, @@ -98900,7 +99706,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateNetworkPerformanceOptions", "traits": { "aws.protocols#ec2QueryName": "NetworkPerformanceOptions", - "smithy.api#documentation": "Contains the launch template settings for network performance options for \n \tyour instance.
", + "smithy.api#documentation": "Contains the launch template settings for network performance options for your\n instance.
", "smithy.api#xmlName": "networkPerformanceOptions" } } @@ -103472,6 +104278,12 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#SensitiveMacCredentials": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ec2#SensitiveUrl": { "type": "string", "traits": { @@ -106624,6 +107436,13 @@ "smithy.api#xmlName": "FilterInArn" } }, + "FilterOutArns": { + "target": "com.amazonaws.ec2#ArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the resources that the path will ignore.
", + "smithy.api#xmlName": "FilterOutArn" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -108122,7 +108941,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is \n reserved and cannot be specified in a request
", + "smithy.api#documentation": "The number of instances the Convertible Reserved Instance offering can be applied to. This\n parameter is reserved and cannot be specified in a request
", "smithy.api#xmlName": "instanceCount" } }, @@ -108145,7 +108964,7 @@ "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request
" + "smithy.api#documentation": "The number of instances the Convertible Reserved Instance offering can be applied to. This\n parameter is reserved and cannot be specified in a request
" } }, "OfferingId": { @@ -108289,7 +109108,7 @@ "target": "com.amazonaws.ec2#ReservationValue", "traits": { "aws.protocols#ec2QueryName": "ReservationValue", - "smithy.api#documentation": "The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of\n the list value, remaining upfront price, and additional upfront cost of the exchange.
", + "smithy.api#documentation": "The total value of the Convertible Reserved Instances that make up the exchange. This is\n the sum of the list value, remaining upfront price, and additional upfront cost of the\n exchange.
", "smithy.api#xmlName": "reservationValue" } }, @@ -112626,7 +113445,7 @@ "target": "com.amazonaws.ec2#UnassignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.
" + "smithy.api#documentation": "Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network\n interface.
" } }, "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { @@ -112703,7 +113522,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.
", + "smithy.api#documentation": "Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation\n prefixes from a network interface.
", "smithy.api#examples": [ { "title": "To unassign a secondary private IP address from a network interface", @@ -112742,7 +113561,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "The secondary private IP addresses to unassign from the network interface. You can specify this \n \toption multiple times to unassign more than one IP address.
", + "smithy.api#documentation": "The secondary private IP addresses to unassign from the network interface. You can\n specify this option multiple times to unassign more than one IP address.
", "smithy.api#xmlName": "privateIpAddress" } } @@ -115420,6 +116239,14 @@ "smithy.api#xmlName": "operator" } }, + "VolumeInitializationRate": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeInitializationRate", + "smithy.api#documentation": "The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, \n in MiB/s. If no volume initialization rate was specified, the value is null.
Information about the instances to which the volume is attached.
", "smithy.api#xmlName": "attachmentStatuses" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "The ID of the Availability Zone.
", + "smithy.api#xmlName": "availabilityZoneId" + } } }, "traits": { diff --git a/models/ecs/service/2014-11-13/ecs-2014-11-13.json b/models/ecs/service/2014-11-13/ecs-2014-11-13.json index 06b1e6e8..25ea4fb3 100644 --- a/models/ecs/service/2014-11-13/ecs-2014-11-13.json +++ b/models/ecs/service/2014-11-13/ecs-2014-11-13.json @@ -1813,7 +1813,7 @@ "configuration": { "target": "com.amazonaws.ecs#ClusterConfiguration", "traits": { - "smithy.api#documentation": "The execute command configuration for the cluster.
" + "smithy.api#documentation": "The execute command and managed storage configuration for the cluster.
" } }, "status": { @@ -2217,7 +2217,7 @@ "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" + "smithy.api#documentation": "A short (1024 max characters) human-readable string to provide additional details about a\n\t\t\trunning or stopped container.
" } }, "networkBindings": { @@ -4220,7 +4220,7 @@ ], "environment": [], "essential": true, - "image": "ubuntu", + "image": "public.ecr.aws/docker/library/ubuntu:latest", "memory": 100, "mountPoints": [], "name": "wave", @@ -4819,34 +4819,32 @@ "smithy.api#examples": [ { "title": "To deregister a revision of a task definition", - "documentation": "This example deregisters the first revision of the curler task definition", + "documentation": "This example deregisters the first revision of the fargate-task task definition", "input": { - "taskDefinition": "curler:1" + "taskDefinition": "fargate-task:1" }, "output": { "taskDefinition": { "status": "INACTIVE", - "family": "curler", + "family": "fargate-task", "volumes": [], - "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/fargate-task:1", "containerDefinitions": [ { - "environment": [], - "name": "curler", - "mountPoints": [], - "image": "curl:latest", - "cpu": 100, - "portMappings": [], - "entryPoint": [], - "memory": 256, - "command": [ - "curl -v http://example.com/" + "memory": 128, + "cpu": 256, + "portMappings": [ + { + "hostPort": 80, + "containerPort": 80, + "protocol": "tcp" + } ], "essential": true, - "volumesFrom": [] + "name": "nginx", + "image": "public.ecr.aws/docker/library/nginx:latest" } - ], - "revision": 1 + ] } } } @@ -7198,7 +7196,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.
\nFor more information about service event errors, see Amazon ECS service event messages.
", + "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.
\nFor more information about service event errors, see Amazon ECS service\n\t\t\t\tevent messages.
", "smithy.api#error": "client" } }, @@ -8886,13 +8884,13 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt the managed storage.
\nThe key must be a single Region key.
" + "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt Amazon ECS managed storage.
\n When you specify a kmsKeyId, Amazon ECS uses the key to encrypt data volumes\n\t\t\tmanaged by Amazon ECS that are attached to tasks in the cluster. The following data volumes\n\t\t\tare managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes\n\t\t\tattached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The key must be a single Region key.
" } }, "fargateEphemeralStorageKmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify the Key Management Service key ID for the Fargate ephemeral storage.
\nThe key must be a single Region key.
" + "smithy.api#documentation": "Specify the Key Management Service key ID for Fargate ephemeral storage.
\nWhen you specify a fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate uses\n\t\t\tthe key to encrypt data at rest in ephemeral storage. For more information about\n\t\t\tFargate ephemeral storage encryption, see Customer managed keys for Amazon Web Services Fargate ephemeral storage for\n\t\t\t\tAmazon ECS in the Amazon Elastic Container Service Developer Guide.
The key must be a single Region key.
" } } }, @@ -10207,7 +10205,7 @@ "containerDefinitions": [ { "name": "sleep", - "image": "busybox", + "image": "public.ecr.aws/docker/library/busybox:latest", "cpu": 10, "command": [ "sleep", @@ -10228,7 +10226,7 @@ "environment": [], "name": "sleep", "mountPoints": [], - "image": "busybox", + "image": "public.ecr.aws/docker/library/busybox:latest", "cpu": 10, "portMappings": [], "command": [ @@ -11702,13 +11700,13 @@ "encrypted": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS\n\t\t\tencryption by default but set this value as false, the setting is\n\t\t\toverridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption\n\t\t\tby default. This parameter maps 1:1 with the Encrypted parameter of the\n\t\t\t\tCreateVolume API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key\n\t\t\tis specified using this parameter, it overrides Amazon EBS default encryption or any KMS key\n\t\t\tthat you specified for cluster-level managed storage encryption. This parameter maps 1:1\n\t\t\twith the KmsKeyId parameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference. For more information about encrypting\n\t\t\tAmazon EBS volumes attached to tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by\n\t\t\tthe service. You must specify either snapshotId or sizeInGiB\n\t\t\tin your volume configuration. This parameter maps 1:1 with the SnapshotId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume\n\t\t\tto create new volumes for attachment to the tasks maintained by the service. This\n\t\t\tproperty can be specified only if you specify a snapshotId. For more\n\t\t\tinformation, see Initialize Amazon EBS volumes in the Amazon EBS User\n\t\t\t\tGuide.
The filesystem type for the volume. For volumes created from a snapshot, you must\n\t\t\tspecify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available Linux filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The available Windows filesystem types are NTFS.
The filesystem type for the volume. For volumes created from a snapshot, you must\n\t\t\tspecify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the tasks will fail to start.
\nThe available Linux filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The available Windows filesystem types are NTFS.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n\t\t\t\t| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\t\t\t\t\"kernel.shm_rmid_forced\", and Sysctls that start with\n\t\t\t\t\"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with\n\t\t\t\t\"net.*\"\n
All of these values are supported by Fargate.
" + "smithy.api#documentation": "The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n\t\t\t\t| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\t\t\t\t\"kernel.shm_rmid_forced\", and Sysctls that start with\n\t\t\t\t\"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with\n\t\t\t\t\"net.*\". Only namespaced Sysctls that exist within the\n\t\t\tcontainer starting with \"net.* are accepted.
All of these values are supported by Fargate.
" } } }, @@ -13673,13 +13677,13 @@ "encrypted": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS\n\t\t\tencryption by default but set this value as false, the setting is\n\t\t\toverridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption\n\t\t\tby default. This parameter maps 1:1 with the Encrypted parameter of the\n\t\t\t\tCreateVolume API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key\n\t\t\tis specified using this parameter, it overrides Amazon EBS default encryption or any KMS key\n\t\t\tthat you specified for cluster-level managed storage encryption. This parameter maps 1:1\n\t\t\twith the KmsKeyId parameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference. For more information about encrypting\n\t\t\tAmazon EBS volumes attached to a task, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS\n\t\t\tvolume to create a new volume for attachment to the task. This property can be specified\n\t\t\tonly if you specify a snapshotId. For more information, see Initialize Amazon EBS volumes in the Amazon EBS User\n\t\t\t\tGuide.
Creates a persistent application user interface.
" + } + }, + "com.amazonaws.emr#CreatePersistentAppUIInput": { + "type": "structure", + "members": { + "TargetResourceArn": { + "target": "com.amazonaws.emr#ArnType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the target resource.
", + "smithy.api#required": {} + } + }, + "EMRContainersConfig": { + "target": "com.amazonaws.emr#EMRContainersConfig", + "traits": { + "smithy.api#documentation": "The EMR containers configuration.
" + } + }, + "Tags": { + "target": "com.amazonaws.emr#TagList", + "traits": { + "smithy.api#documentation": "Tags for the persistent application user interface.
" + } + }, + "XReferer": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "The cross reference for the persistent application user interface.
" + } + }, + "ProfilerType": { + "target": "com.amazonaws.emr#ProfilerType", + "traits": { + "smithy.api#documentation": "The profiler type for the persistent application user interface. Valid values are SHS, TEZUI, or YTS.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emr#CreatePersistentAppUIOutput": { + "type": "structure", + "members": { + "PersistentAppUIId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The persistent application user interface identifier.
" + } + }, + "RuntimeRoleEnabledCluster": { + "target": "com.amazonaws.emr#Boolean", + "traits": { + "smithy.api#documentation": "Represents if the EMR on EC2 cluster that the persisent application user interface is created for is a runtime role \n enabled cluster or not.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emr#CreateSecurityConfiguration": { "type": "operation", "input": { @@ -2197,6 +2277,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.emr#DescribePersistentAppUI": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#DescribePersistentAppUIInput" + }, + "output": { + "target": "com.amazonaws.emr#DescribePersistentAppUIOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerException" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a persistent application user interface.
" + } + }, + "com.amazonaws.emr#DescribePersistentAppUIInput": { + "type": "structure", + "members": { + "PersistentAppUIId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier for the persistent application user interface.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emr#DescribePersistentAppUIOutput": { + "type": "structure", + "members": { + "PersistentAppUI": { + "target": "com.amazonaws.emr#PersistentAppUI", + "traits": { + "smithy.api#documentation": "The persistent application user interface.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emr#DescribeReleaseLabel": { "type": "operation", "input": { @@ -2496,6 +2626,20 @@ "target": "com.amazonaws.emr#InstanceId" } }, + "com.amazonaws.emr#EMRContainersConfig": { + "type": "structure", + "members": { + "JobRunId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The Job run ID for the container configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The EMR container configuration.
" + } + }, "com.amazonaws.emr#EbsBlockDevice": { "type": "structure", "members": { @@ -2689,6 +2833,9 @@ { "target": "com.amazonaws.emr#CancelSteps" }, + { + "target": "com.amazonaws.emr#CreatePersistentAppUI" + }, { "target": "com.amazonaws.emr#CreateSecurityConfiguration" }, @@ -2716,6 +2863,9 @@ { "target": "com.amazonaws.emr#DescribeNotebookExecution" }, + { + "target": "com.amazonaws.emr#DescribePersistentAppUI" + }, { "target": "com.amazonaws.emr#DescribeReleaseLabel" }, @@ -2740,6 +2890,12 @@ { "target": "com.amazonaws.emr#GetManagedScalingPolicy" }, + { + "target": "com.amazonaws.emr#GetOnClusterAppUIPresignedURL" + }, + { + "target": "com.amazonaws.emr#GetPersistentAppUIPresignedURL" + }, { "target": "com.amazonaws.emr#GetStudioSessionMapping" }, @@ -4223,6 +4379,166 @@ "smithy.api#output": {} } }, + "com.amazonaws.emr#GetOnClusterAppUIPresignedURL": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#GetOnClusterAppUIPresignedURLInput" + }, + "output": { + "target": "com.amazonaws.emr#GetOnClusterAppUIPresignedURLOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerError" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "The presigned URL properties for the cluster's application user interface.
" + } + }, + "com.amazonaws.emr#GetOnClusterAppUIPresignedURLInput": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The cluster ID associated with the cluster's application user interface presigned URL.
", + "smithy.api#required": {} + } + }, + "OnClusterAppUIType": { + "target": "com.amazonaws.emr#OnClusterAppUIType", + "traits": { + "smithy.api#documentation": "The application UI type associated with the cluster's application user interface presigned URL.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The application ID associated with the cluster's application user interface presigned URL.
" + } + }, + "DryRun": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "Determines if the user interface presigned URL is for a dry run.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.emr#ArnType", + "traits": { + "smithy.api#documentation": "The execution role ARN associated with the cluster's application user interface \n presigned URL.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emr#GetOnClusterAppUIPresignedURLOutput": { + "type": "structure", + "members": { + "PresignedURLReady": { + "target": "com.amazonaws.emr#Boolean", + "traits": { + "smithy.api#documentation": "Used to determine if the presigned URL is ready.
" + } + }, + "PresignedURL": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "The cluster's generated presigned URL.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emr#GetPersistentAppUIPresignedURL": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#GetPersistentAppUIPresignedURLInput" + }, + "output": { + "target": "com.amazonaws.emr#GetPersistentAppUIPresignedURLOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerError" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "The presigned URL properties for the cluster's application user interface.
" + } + }, + "com.amazonaws.emr#GetPersistentAppUIPresignedURLInput": { + "type": "structure", + "members": { + "PersistentAppUIId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The persistent application user interface ID associated with the presigned URL.
", + "smithy.api#required": {} + } + }, + "PersistentAppUIType": { + "target": "com.amazonaws.emr#PersistentAppUIType", + "traits": { + "smithy.api#documentation": "The persistent application user interface type associated with the presigned URL.
" + } + }, + "ApplicationId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The application ID associated with the presigned URL.
" + } + }, + "AuthProxyCall": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "A boolean that represents if the caller is an authentication proxy call.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.emr#ArnType", + "traits": { + "smithy.api#documentation": "The execution role ARN associated with the presigned URL.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emr#GetPersistentAppUIPresignedURLOutput": { + "type": "structure", + "members": { + "PresignedURLReady": { + "target": "com.amazonaws.emr#Boolean", + "traits": { + "smithy.api#documentation": "Used to determine if the presigned URL is ready.
" + } + }, + "PresignedURL": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "The returned presigned URL.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emr#GetStudioSessionMapping": { "type": "operation", "input": { @@ -7821,6 +8137,47 @@ "target": "com.amazonaws.emr#OSRelease" } }, + "com.amazonaws.emr#OnClusterAppUIType": { + "type": "enum", + "members": { + "SparkHistoryServer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SparkHistoryServer" + } + }, + "YarnTimelineService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YarnTimelineService" + } + }, + "TezUI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TezUI" + } + }, + "ApplicationMaster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplicationMaster" + } + }, + "JobHistoryServer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JobHistoryServer" + } + }, + "ResourceManager": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceManager" + } + } + } + }, "com.amazonaws.emr#OnDemandCapacityReservationOptions": { "type": "structure", "members": { @@ -7997,6 +8354,91 @@ "smithy.api#documentation": "The Amazon S3 location that stores the notebook execution output.
" } }, + "com.amazonaws.emr#PersistentAppUI": { + "type": "structure", + "members": { + "PersistentAppUIId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The identifier for the persistent application user interface object.
" + } + }, + "PersistentAppUITypeList": { + "target": "com.amazonaws.emr#PersistentAppUITypeList", + "traits": { + "smithy.api#documentation": "The type list for the persistent application user interface object. Valid values \n include SHS, YTS, or TEZ.
" + } + }, + "PersistentAppUIStatus": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The status for the persistent application user interface object.
" + } + }, + "AuthorId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "The author ID for the persistent application user interface object.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "The creation date and time for the persistent application user interface object.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "The date and time the persistent application user interface object was last changed.
" + } + }, + "LastStateChangeReason": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "The reason the persistent application user interface object was last changed.
" + } + }, + "Tags": { + "target": "com.amazonaws.emr#TagList", + "traits": { + "smithy.api#documentation": "A collection of tags for the persistent application user interface object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Holds persistent application user interface information. Applications installed on the Amazon EMR cluster publish user interfaces as \n web sites to monitor cluster activity.
" + } + }, + "com.amazonaws.emr#PersistentAppUIType": { + "type": "enum", + "members": { + "SHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHS" + } + }, + "TEZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEZ" + } + }, + "YTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YTS" + } + } + } + }, + "com.amazonaws.emr#PersistentAppUITypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.emr#PersistentAppUIType" + } + }, "com.amazonaws.emr#PlacementGroupConfig": { "type": "structure", "members": { @@ -8111,6 +8553,29 @@ "target": "com.amazonaws.emr#PortRange" } }, + "com.amazonaws.emr#ProfilerType": { + "type": "enum", + "members": { + "SHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHS" + } + }, + "TEZUI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEZUI" + } + }, + "YTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YTS" + } + } + } + }, "com.amazonaws.emr#PutAutoScalingPolicy": { "type": "operation", "input": { diff --git a/models/firehose/service/2015-08-04/firehose-2015-08-04.json b/models/firehose/service/2015-08-04/firehose-2015-08-04.json index 414e56b5..587dcc70 100644 --- a/models/firehose/service/2015-08-04/firehose-2015-08-04.json +++ b/models/firehose/service/2015-08-04/firehose-2015-08-04.json @@ -4138,7 +4138,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "^arn:.*:glue:.*:\\d{12}:catalog$" + "smithy.api#pattern": "^arn:.*:glue:.*:\\d{12}:catalog(?:(/[a-z0-9_-]+){1,2})?$" } }, "com.amazonaws.firehose#HECAcknowledgmentTimeoutInSeconds": { @@ -6686,7 +6686,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@]+$" + "smithy.api#pattern": "^arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@!]+$" } }, "com.amazonaws.firehose#SecretsManagerConfiguration": { diff --git a/models/glue/service/2017-03-31/glue-2017-03-31.json b/models/glue/service/2017-03-31/glue-2017-03-31.json index c2c863df..4f05c574 100644 --- a/models/glue/service/2017-03-31/glue-2017-03-31.json +++ b/models/glue/service/2017-03-31/glue-2017-03-31.json @@ -5895,6 +5895,12 @@ "smithy.api#documentation": "Specifies a command-separated value (CSV) data store stored in Amazon S3.
" } }, + "S3ExcelSource": { + "target": "com.amazonaws.glue#S3ExcelSource", + "traits": { + "smithy.api#documentation": "Defines configuration parameters for reading Excel files from Amazon S3.
" + } + }, "S3JsonSource": { "target": "com.amazonaws.glue#S3JsonSource", "traits": { @@ -5955,12 +5961,24 @@ "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" } }, + "S3HyperDirectTarget": { + "target": "com.amazonaws.glue#S3HyperDirectTarget", + "traits": { + "smithy.api#documentation": "Defines configuration parameters for writing data to Amazon S3 using HyperDirect optimization.
" + } + }, "S3DirectTarget": { "target": "com.amazonaws.glue#S3DirectTarget", "traits": { "smithy.api#documentation": "Specifies a data target that writes to Amazon S3.
" } }, + "S3IcebergDirectTarget": { + "target": "com.amazonaws.glue#S3IcebergDirectTarget", + "traits": { + "smithy.api#documentation": "Defines configuration parameters for writing data to Amazon S3 as an Apache Iceberg table.
" + } + }, "ApplyMapping": { "target": "com.amazonaws.glue#ApplyMapping", "traits": { @@ -8356,17 +8374,47 @@ "smithy.api#documentation": "The name of the connection type.
" } }, + "DisplayName": { + "target": "com.amazonaws.glue#DisplayName", + "traits": { + "smithy.api#documentation": "The human-readable name for the connection type that is displayed in the Glue console.
" + } + }, + "Vendor": { + "target": "com.amazonaws.glue#Vendor", + "traits": { + "smithy.api#documentation": "The name of the vendor or provider that created or maintains this connection type.
" + } + }, "Description": { "target": "com.amazonaws.glue#Description", "traits": { "smithy.api#documentation": "A description of the connection type.
" } }, + "Categories": { + "target": "com.amazonaws.glue#ListOfString", + "traits": { + "smithy.api#documentation": "A list of categories that this connection type belongs to. Categories help users filter and find appropriate connection types based on their \n use cases.
" + } + }, "Capabilities": { "target": "com.amazonaws.glue#Capabilities", "traits": { "smithy.api#documentation": "The supported authentication types, data interface types (compute environments), and data operations of the connector.
" } + }, + "LogoUrl": { + "target": "com.amazonaws.glue#UrlString", + "traits": { + "smithy.api#documentation": "The URL of the logo associated with a connection type.
" + } + }, + "ConnectionTypeVariants": { + "target": "com.amazonaws.glue#ConnectionTypeVariantList", + "traits": { + "smithy.api#documentation": "A list of variants available for this connection type. Different variants may provide specialized configurations for specific use cases or \n implementations of the same general connection type.
" + } } }, "traits": { @@ -8379,6 +8427,44 @@ "target": "com.amazonaws.glue#ConnectionTypeBrief" } }, + "com.amazonaws.glue#ConnectionTypeVariant": { + "type": "structure", + "members": { + "ConnectionTypeVariantName": { + "target": "com.amazonaws.glue#DisplayName", + "traits": { + "smithy.api#documentation": "The unique identifier for the connection type variant. This name is used internally to identify the specific variant of a connection type.\n
" + } + }, + "DisplayName": { + "target": "com.amazonaws.glue#DisplayName", + "traits": { + "smithy.api#documentation": "The human-readable name for the connection type variant that is displayed in the Glue console.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#Description", + "traits": { + "smithy.api#documentation": "A detailed description of the connection type variant, including its purpose, use cases, and any specific configuration requirements.
" + } + }, + "LogoUrl": { + "target": "com.amazonaws.glue#UrlString", + "traits": { + "smithy.api#documentation": "The URL of the logo associated with a connection type variant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a variant of a connection type in Glue Data Catalog. Connection type variants provide specific configurations and behaviors \n for different implementations of the same general connection type.
" + } + }, + "com.amazonaws.glue#ConnectionTypeVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ConnectionTypeVariant" + } + }, "com.amazonaws.glue#ConnectionsList": { "type": "structure", "members": { @@ -10376,6 +10462,12 @@ "traits": { "smithy.api#documentation": "Metadata assigned to the resource consisting of a list of key-value pairs.
" } + }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig", + "traits": { + "smithy.api#documentation": "The configuration settings.
" + } } }, "traits": { @@ -10554,6 +10646,12 @@ "traits": { "smithy.api#documentation": "Selects source tables for the integration using Maxwell filter syntax.
" } + }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig", + "traits": { + "smithy.api#documentation": "The configuration settings.
" + } } }, "traits": { @@ -10615,7 +10713,7 @@ "SourceTableConfig": { "target": "com.amazonaws.glue#SourceTableConfig", "traits": { - "smithy.api#documentation": "A structure for the source table configuration.
" + "smithy.api#documentation": "A structure for the source table configuration. See the SourceTableConfig structure to see list of supported source properties.
A policy that specifies update behavior for the crawler.
" } }, + "com.amazonaws.glue#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.glue#Double": { "type": "double", "traits": { @@ -25643,6 +25750,17 @@ "target": "com.amazonaws.glue#HudiTarget" } }, + "com.amazonaws.glue#HyperTargetCompressionType": { + "type": "enum", + "members": { + "UNCOMPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uncompressed" + } + } + } + }, "com.amazonaws.glue#IAMRoleArn": { "type": "string", "traits": { @@ -25877,6 +25995,35 @@ "smithy.api#documentation": "Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
" } }, + "com.amazonaws.glue#IcebergTargetCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gzip" + } + }, + "LZO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lzo" + } + }, + "UNCOMPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uncompressed" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "snappy" + } + } + } + }, "com.amazonaws.glue#IcebergTargetList": { "type": "list", "member": { @@ -26056,6 +26203,12 @@ "smithy.api#required": {} } }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig", + "traits": { + "smithy.api#documentation": "Properties associated with the integration.
" + } + }, "Errors": { "target": "com.amazonaws.glue#IntegrationErrorList", "traits": { @@ -26187,6 +26340,12 @@ "smithy.api#required": {} } }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig", + "traits": { + "smithy.api#documentation": "Properties associated with the integration.
" + } + }, "Errors": { "target": "com.amazonaws.glue#IntegrationErrorList", "traits": { @@ -26213,6 +26372,20 @@ "target": "com.amazonaws.glue#IntegrationString" } }, + "com.amazonaws.glue#IntegrationConfig": { + "type": "structure", + "members": { + "RefreshInterval": { + "target": "com.amazonaws.glue#String128", + "traits": { + "smithy.api#documentation": "Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align \n the refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from \n 15 minutes to 8640 minutes (six days). Currently supports creation of RefreshInterval only.
Properties associated with the integration.
" + } + }, "com.amazonaws.glue#IntegrationConflictOperationFault": { "type": "structure", "members": { @@ -26325,13 +26498,13 @@ "FieldName": { "target": "com.amazonaws.glue#String128", "traits": { - "smithy.api#documentation": "The field name used to partition data on the target.
" + "smithy.api#documentation": "The field name used to partition data on the target. Avoid using columns that have unique values for each row (for example, `LastModifiedTimestamp`, \n `SystemModTimeStamp`) as the partition column. These columns are not suitable for partitioning because they create a large number of small partitions, \n which can lead to performance issues.
" } }, "FunctionSpec": { "target": "com.amazonaws.glue#String128", "traits": { - "smithy.api#documentation": "Specifies a function used to partition data on the target.
" + "smithy.api#documentation": "Specifies the function used to partition data on the target. The only accepted value for this parameter is `'identity'` (string). \n The `'identity'` function ensures that the data partitioning on the target follows the same scheme as the source. In other words, the partitioning \n structure of the source data is preserved in the target destination.
" } } }, @@ -31784,6 +31957,9 @@ "com.amazonaws.glue#NullableString": { "type": "string" }, + "com.amazonaws.glue#NumberTargetPartitionsString": { + "type": "string" + }, "com.amazonaws.glue#OAuth2ClientApplication": { "type": "structure", "members": { @@ -32503,6 +32679,18 @@ "smithy.api#enumValue": "gzip" } }, + "BROTLI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "brotli" + } + }, + "LZ4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lz4" + } + }, "UNCOMPRESSED": { "target": "smithy.api#Unit", "traits": { @@ -35517,6 +35705,12 @@ "smithy.api#required": {} } }, + "NumberTargetPartitions": { + "target": "com.amazonaws.glue#NumberTargetPartitionsString", + "traits": { + "smithy.api#documentation": "Specifies the number of target partitions for distributing Delta Lake dataset files across Amazon S3.
" + } + }, "Format": { "target": "com.amazonaws.glue#TargetFormat", "traits": { @@ -35649,6 +35843,12 @@ "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions when writing data directly to Amazon S3.
" + } + }, "Format": { "target": "com.amazonaws.glue#TargetFormat", "traits": { @@ -35716,6 +35916,94 @@ } } }, + "com.amazonaws.glue#S3ExcelSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the S3 Excel data source.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "The S3 paths where the Excel files are located.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.glue#ParquetCompressionType", + "traits": { + "smithy.api#documentation": "The compression format used for the Excel files.
" + } + }, + "Exclusions": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "Patterns to exclude specific files or paths from processing.
" + } + }, + "GroupSize": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Defines the size of file groups for batch processing.
" + } + }, + "GroupFiles": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies how files should be grouped for processing.
" + } + }, + "Recurse": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether to recursively process subdirectories.
" + } + }, + "MaxBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "The maximum number of processing bands to use.
" + } + }, + "MaxFilesInBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "The maximum number of files to process in each band.
" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#S3DirectSourceAdditionalOptions", + "traits": { + "smithy.api#documentation": "Additional configuration options for S3 direct source processing.
" + } + }, + "NumberRows": { + "target": "com.amazonaws.glue#BoxedLong", + "traits": { + "smithy.api#documentation": "The number of rows to process from each Excel file.
" + } + }, + "SkipFooter": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "The number of rows to skip at the end of each Excel file.
" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "The AWS Glue schemas to apply to the processed data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an S3 Excel data source.
" + } + }, "com.amazonaws.glue#S3GlueParquetTarget": { "type": "structure", "members": { @@ -35752,6 +36040,12 @@ "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions for Parquet files when writing to Amazon S3 using AWS Glue.
" + } + }, "SchemaChangePolicy": { "target": "com.amazonaws.glue#DirectSchemaChangePolicy", "traits": { @@ -35849,6 +36143,12 @@ "smithy.api#required": {} } }, + "NumberTargetPartitions": { + "target": "com.amazonaws.glue#NumberTargetPartitionsString", + "traits": { + "smithy.api#documentation": "Specifies the number of target partitions for distributing Hudi dataset files across Amazon S3.
" + } + }, "PartitionKeys": { "target": "com.amazonaws.glue#GlueStudioPathList", "traits": { @@ -35920,6 +36220,120 @@ "smithy.api#documentation": "Specifies a Hudi data source stored in Amazon S3.
" } }, + "com.amazonaws.glue#S3HyperDirectTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The unique identifier for the HyperDirect target node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "Specifies the input source for the HyperDirect target.
", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Defines the partitioning strategy for the output data.
" + } + }, + "Path": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The S3 location where the output data will be written.
", + "smithy.api#required": {} + } + }, + "Compression": { + "target": "com.amazonaws.glue#HyperTargetCompressionType", + "traits": { + "smithy.api#documentation": "The compression type to apply to the output data.
" + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#DirectSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "Defines how schema changes are handled during write operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a HyperDirect data target that writes to Amazon S3.
" + } + }, + "com.amazonaws.glue#S3IcebergDirectTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "Specifies the unique identifier for the Iceberg target node in your data pipeline.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "Defines the single input source that provides data to this Iceberg target.
", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Specifies the columns used to partition the Iceberg table data in S3.
" + } + }, + "Path": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Defines the S3 location where the Iceberg table data will be stored.
", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.glue#TargetFormat", + "traits": { + "smithy.api#documentation": "Specifies the file format used for storing Iceberg table data (e.g., Parquet, ORC).
", + "smithy.api#required": {} + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "Provides additional configuration options for customizing the Iceberg table behavior.
" + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#DirectSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "Defines how schema changes are handled when writing data to the Iceberg table.
" + } + }, + "Compression": { + "target": "com.amazonaws.glue#IcebergTargetCompressionType", + "traits": { + "smithy.api#documentation": "Specifies the compression codec used for Iceberg table files in S3.
", + "smithy.api#required": {} + } + }, + "NumberTargetPartitions": { + "target": "com.amazonaws.glue#NumberTargetPartitionsString", + "traits": { + "smithy.api#documentation": "Sets the number of target partitions for distributing Iceberg table files across S3.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that writes to an Iceberg data source in Amazon S3.
" + } + }, "com.amazonaws.glue#S3JsonSource": { "type": "structure", "members": { @@ -37587,25 +38001,25 @@ "Fields": { "target": "com.amazonaws.glue#SourceTableFieldsList", "traits": { - "smithy.api#documentation": "A list of fields used for column-level filtering.
" + "smithy.api#documentation": "A list of fields used for column-level filtering. Currently unsupported.
" } }, "FilterPredicate": { "target": "com.amazonaws.glue#String128", "traits": { - "smithy.api#documentation": "A condition clause used for row-level filtering.
" + "smithy.api#documentation": "A condition clause used for row-level filtering. Currently unsupported.
" } }, "PrimaryKey": { "target": "com.amazonaws.glue#PrimaryKeyList", "traits": { - "smithy.api#documentation": "Unique identifier of a record.
" + "smithy.api#documentation": "Provide the primary key set for this table. Currently supported specifically for SAP EntityOf entities upon request. Contact \n Amazon Web Services Support to make this feature available.
Incremental pull timestamp-based field.
" + "smithy.api#documentation": "Incremental pull timestamp-based field. Currently unsupported.
" } } }, @@ -40766,6 +41180,24 @@ "traits": { "smithy.api#enumValue": "delta" } + }, + "ICEBERG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iceberg" + } + }, + "HYPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hyper" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xml" + } } } }, @@ -44541,6 +44973,9 @@ "com.amazonaws.glue#UriString": { "type": "string" }, + "com.amazonaws.glue#UrlString": { + "type": "string" + }, "com.amazonaws.glue#UsageProfileDefinition": { "type": "structure", "members": { @@ -44740,6 +45175,15 @@ "target": "com.amazonaws.glue#ValueString" } }, + "com.amazonaws.glue#Vendor": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.glue#VersionId": { "type": "long", "traits": { diff --git a/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json b/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json index f7cf3538..0c3e5d9e 100644 --- a/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json +++ b/models/guardduty/service/2017-11-28/guardduty-2017-11-28.json @@ -5835,7 +5835,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the location of the remote IP address.
" + "smithy.api#documentation": "Contains information about the location of the remote IP address. By default, GuardDuty\n returns Geolocation with Lat and Lon as 0.0.
The base image of the image recipe. The value of the string can be the ARN of the base\n\t\t\timage or an AMI ID. The format for the ARN follows this example:\n\t\t\t\tarn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.\n\t\t\tYou can provide the specific version that you want to use, or you can use a wildcard in\n\t\t\tall of the fields. If you enter an AMI ID for the string value, you must have access to\n\t\t\tthe AMI, and the AMI must be in the same Region in which you are using Image Builder.
The base image for customizations specified in the image recipe. You can specify the \n\t\t\tparent image using one of the following options:
\nAMI ID
\nImage Builder image Amazon Resource Name (ARN)
\nAmazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\t\t\t\tfollowed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
\nIf you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access \n\t\t\tto the AMI, and the AMI must be in the source Region.
", "smithy.api#required": {} } }, diff --git a/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json b/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json index e121ed21..8afda55a 100644 --- a/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json +++ b/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json @@ -820,6 +820,18 @@ "traits": { "smithy.api#documentation": "The value to sort by.
" } + }, + "lastInUseAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + } + }, + "inUseCount": { + "target": "com.amazonaws.inspector2#NumberFilterList", + "traits": { + "smithy.api#documentation": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + } } }, "traits": { @@ -871,6 +883,18 @@ "traits": { "smithy.api#documentation": "The number of finding by severity.
" } + }, + "lastInUseAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + } + }, + "inUseCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + } } }, "traits": { @@ -930,6 +954,18 @@ "traits": { "smithy.api#documentation": "The platform of the Amazon ECR container image.
" } + }, + "lastInUseAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + } + }, + "inUseCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + } } }, "traits": { @@ -955,6 +991,101 @@ ] } }, + "com.amazonaws.inspector2#AwsEcsMetadataDetails": { + "type": "structure", + "members": { + "detailsGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The details group information for a task in a cluster.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#required": {} + } + }, + "taskDefinitionArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The task definition ARN.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about tasks where an image was in use.
" + } + }, + "com.amazonaws.inspector2#AwsEksMetadataDetails": { + "type": "structure", + "members": { + "namespace": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The namespace for an Amazon EKS cluster.
", + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "workloadInfoList": { + "target": "com.amazonaws.inspector2#AwsEksWorkloadInfoList", + "traits": { + "smithy.api#documentation": "The list of workloads.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for an Amazon EKS pod where an Amazon ECR image is in use.
" + } + }, + "com.amazonaws.inspector2#AwsEksWorkloadInfo": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the workload.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The workload type.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the workload.
" + } + }, + "com.amazonaws.inspector2#AwsEksWorkloadInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AwsEksWorkloadInfo" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, "com.amazonaws.inspector2#AwsLambdaFunctionDetails": { "type": "structure", "members": { @@ -3116,6 +3247,123 @@ } } }, + "com.amazonaws.inspector2#ClusterDetails": { + "type": "structure", + "members": { + "lastInUse": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The last timestamp when Amazon Inspector recorded the image in use in the task or pod in the cluster.
", + "smithy.api#required": {} + } + }, + "runningUnitCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of tasks or pods where an image was running on the cluster.
" + } + }, + "stoppedUnitCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of tasks or pods where an image was stopped on the cluster in the last 24 hours.
" + } + }, + "clusterMetadata": { + "target": "com.amazonaws.inspector2#ClusterMetadata", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the task or pod in the cluster.
" + } + }, + "com.amazonaws.inspector2#ClusterDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ClusterDetails" + } + }, + "com.amazonaws.inspector2#ClusterForImageFilterCriteria": { + "type": "structure", + "members": { + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The resource Id to be used in the filter criteria.
", + "smithy.api#pattern": "^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter criteria to be used.
" + } + }, + "com.amazonaws.inspector2#ClusterInformation": { + "type": "structure", + "members": { + "clusterArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The cluster ARN.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(?:-[a-z0-9-]+)?:(?:ecs|eks):[a-z0-9-]+:[0-9]{12}:cluster/[a-zA-Z0-9_-]+$", + "smithy.api#required": {} + } + }, + "clusterDetails": { + "target": "com.amazonaws.inspector2#ClusterDetailsList", + "traits": { + "smithy.api#documentation": "Details about the cluster.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the cluster.
" + } + }, + "com.amazonaws.inspector2#ClusterInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ClusterInformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ClusterMetadata": { + "type": "union", + "members": { + "awsEcsMetadataDetails": { + "target": "com.amazonaws.inspector2#AwsEcsMetadataDetails", + "traits": { + "smithy.api#documentation": "The details for an Amazon ECS cluster in the cluster metadata.
" + } + }, + "awsEksMetadataDetails": { + "target": "com.amazonaws.inspector2#AwsEksMetadataDetails", + "traits": { + "smithy.api#documentation": "The details for an Amazon EKS cluster in the cluster metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata for a cluster.
" + } + }, "com.amazonaws.inspector2#CodeFilePath": { "type": "structure", "members": { @@ -3576,6 +3824,18 @@ "traits": { "smithy.api#documentation": "The date an image was last pulled at.
" } + }, + "ecrImageLastInUseAt": { + "target": "com.amazonaws.inspector2#CoverageDateFilterList", + "traits": { + "smithy.api#documentation": "The Amazon ECR image that was last in use.
" + } + }, + "ecrImageInUseCount": { + "target": "com.amazonaws.inspector2#CoverageNumberFilterList", + "traits": { + "smithy.api#documentation": "The number of Amazon ECR images in use.
" + } } }, "traits": { @@ -3633,6 +3893,38 @@ } } }, + "com.amazonaws.inspector2#CoverageNumberFilter": { + "type": "structure", + "members": { + "upperInclusive": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The upper inclusive for the coverage number.>
" + } + }, + "lowerInclusive": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The lower inclusive for the coverage number.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The coverage number to be used in the filter.
" + } + }, + "com.amazonaws.inspector2#CoverageNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageNumberFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.inspector2#CoverageResourceType": { "type": "string", "traits": { @@ -5284,6 +5576,12 @@ "traits": { "smithy.api#documentation": "The rescan duration configured for image pull date.
" } + }, + "pullDateRescanMode": { + "target": "com.amazonaws.inspector2#EcrPullDateRescanMode", + "traits": { + "smithy.api#documentation": "The pull date for the re-scan mode.
" + } } }, "traits": { @@ -5318,6 +5616,18 @@ "traits": { "smithy.api#documentation": "The date an image was last pulled at.
" } + }, + "lastInUseAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + } + }, + "inUseCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + } } }, "traits": { @@ -5351,6 +5661,21 @@ ] } }, + "com.amazonaws.inspector2#EcrPullDateRescanMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LAST_PULL_DATE", + "name": "LAST_PULL_DATE" + }, + { + "value": "LAST_IN_USE_AT", + "name": "LAST_IN_USE_AT" + } + ] + } + }, "com.amazonaws.inspector2#EcrRepositoryMetadata": { "type": "structure", "members": { @@ -5428,6 +5753,12 @@ "traits": { "smithy.api#documentation": "The rescan duration configured for image pull date.
" } + }, + "pullDateRescanMode": { + "target": "com.amazonaws.inspector2#EcrPullDateRescanMode", + "traits": { + "smithy.api#documentation": "The pull date for the re-scan mode.
" + } } }, "traits": { @@ -6224,6 +6555,18 @@ "smithy.api#documentation": "Details of the Amazon ECR image hashes used to filter findings.
" } }, + "ecrImageLastInUseAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
" + } + }, + "ecrImageInUseCount": { + "target": "com.amazonaws.inspector2#NumberFilterList", + "traits": { + "smithy.api#documentation": "Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
" + } + }, "portRange": { "target": "com.amazonaws.inspector2#PortRangeFilterList", "traits": { @@ -7275,6 +7618,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.inspector2#GetClustersForImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetClustersForImageRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetClustersForImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of clusters and metadata associated with an image.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cluster/get" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "cluster" + } + } + }, + "com.amazonaws.inspector2#GetClustersForImageNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3000 + } + } + }, + "com.amazonaws.inspector2#GetClustersForImageRequest": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.inspector2#ClusterForImageFilterCriteria", + "traits": { + "smithy.api#documentation": "The resource Id for the Amazon ECR image.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned in a single page of results.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#GetClustersForImageNextToken", + "traits": { + "smithy.api#documentation": "The pagination token from a previous request used to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetClustersForImageResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.inspector2#ClusterInformationList", + "traits": { + "smithy.api#documentation": "A unit of work inside of a cluster, which can include metadata about the cluster.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#GetClustersForImageNextToken", + "traits": { + "smithy.api#documentation": "The pagination token from a previous request used to retrieve the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.inspector2#GetConfiguration": { "type": "operation", "input": { @@ -7975,6 +8416,9 @@ { "target": "com.amazonaws.inspector2#GetCisScanResultDetails" }, + { + "target": "com.amazonaws.inspector2#GetClustersForImage" + }, { "target": "com.amazonaws.inspector2#GetConfiguration" }, @@ -12835,6 +13279,10 @@ { "value": "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED", "name": "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED" + }, + { + "value": "PENDING_REVIVAL_SCAN", + "name": "PENDING_REVIVAL_SCAN" } ] } diff --git a/models/license-manager/service/2018-08-01/license-manager-2018-08-01.json b/models/license-manager/service/2018-08-01/license-manager-2018-08-01.json index 95022508..8fff6c76 100644 --- a/models/license-manager/service/2018-08-01/license-manager-2018-08-01.json +++ b/models/license-manager/service/2018-08-01/license-manager-2018-08-01.json @@ -1347,7 +1347,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 7 + "max": 8 } } }, @@ -1991,6 +1991,12 @@ "smithy.api#documentation": "Allowed operations for the grant.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.licensemanager#TagList", + "traits": { + "smithy.api#documentation": "Tags to add to the grant. For more information about tagging support in\n License Manager, see the TagResource operation.
" + } } }, "traits": { @@ -2247,7 +2253,7 @@ "LicenseRules": { "target": "com.amazonaws.licensemanager#StringList", "traits": { - "smithy.api#documentation": "License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules \n vary by dimension, as follows.
\n\n Cores dimension: allowedTenancy |\n licenseAffinityToHost |\n maximumCores | minimumCores\n
\n Instances dimension: allowedTenancy | \n maximumCores | minimumCores |\n maximumSockets | minimumSockets |\n maximumVcpus | minimumVcpus\n
\n Sockets dimension: allowedTenancy | \n licenseAffinityToHost |\n maximumSockets | minimumSockets\n
\n vCPUs dimension: allowedTenancy | \n honorVcpuOptimization | \n maximumVcpus | minimumVcpus\n
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible \n values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and \n EC2-DedicatedInstance. The possible values for honorVcpuOptimization are \n True and False.
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules \n vary by dimension, as follows.
\n\n Cores dimension: allowedTenancy |\n licenseAffinityToHost |\n maximumCores | minimumCores\n
\n Instances dimension: allowedTenancy | \n maximumVcpus | minimumVcpus\n
\n Sockets dimension: allowedTenancy | \n licenseAffinityToHost |\n maximumSockets | minimumSockets\n
\n vCPUs dimension: allowedTenancy | \n honorVcpuOptimization | \n maximumVcpus | minimumVcpus\n
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible \n values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and \n EC2-DedicatedInstance. The possible values for honorVcpuOptimization are \n True and False.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.licensemanager#TagList", + "traits": { + "smithy.api#documentation": "Tags to add to the license. For more information about tagging support in\n License Manager, see the TagResource operation.
" + } } }, "traits": { @@ -5861,7 +5873,7 @@ "Filters": { "target": "com.amazonaws.licensemanager#Filters", "traits": { - "smithy.api#documentation": "Filters to scope the results. The following filters and logical operators\n are supported:
\n\n licenseCountingType - The dimension for which licenses are counted.\n Possible values are vCPU | Instance | Core | Socket.\n Logical operators are EQUALS | NOT_EQUALS.
\n enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. \n Logical operators are EQUALS | NOT_EQUALS.
\n usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. \n Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators\n are supported:
\n\n licenseCountingType - The dimension for which licenses are counted.\n Possible values are vCPU | Instance | Core | Socket.
\n enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.
\n usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded.
Lists the tags for the specified license configuration.
" + "smithy.api#documentation": "Lists the tags for the specified resource. For more information about tagging support in\n License Manager, see the TagResource operation.
" } }, "com.amazonaws.licensemanager#ListTagsForResourceRequest": { @@ -6743,7 +6755,7 @@ "ResourceArn": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the license configuration.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } } @@ -6904,7 +6916,7 @@ "Filters": { "target": "com.amazonaws.licensemanager#Filters", "traits": { - "smithy.api#documentation": "Filters to scope the results. The following filters and logical operators\n are supported:
\n\n resourceArn - The ARN of the license configuration resource.\n Logical operators are EQUALS | NOT_EQUALS.
\n resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). \n Logical operators are EQUALS | NOT_EQUALS.
\n resourceAccount - The ID of the account that owns the resource. \n Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators\n are supported:
\n\n resourceArn - The ARN of the license configuration resource.
\n resourceType - The resource type (EC2_INSTANCE | \n \tEC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE).
\n resourceAccount - The ID of the account that owns the resource.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type \n is SSM_MANAGED:
\n Application Name - The name of the application.\n Logical operator is EQUALS.
\n Application Publisher - The publisher of the application.\n Logical operator is EQUALS.
\n Application Version - The version of the application.\n Logical operator is EQUALS.
\n Platform Name - The name of the platform.\n Logical operator is EQUALS.
\n Platform Type - The platform type.\n Logical operator is EQUALS.
\n Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.\n
\n AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery.\n Logical operator is NOT_EQUALS.
\n License Included - The type of license included.\n Logical operators are EQUALS and NOT_EQUALS.\n Possible values are: sql-server-enterprise | \n sql-server-standard | \n sql-server-web | \n windows-server-datacenter.
The following filters and logical operators are supported when the resource type\n is RDS:
\n Engine Edition - The edition of the database engine.\n Logical operator is EQUALS.\n Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.
\n License Pack - The license pack.\n Logical operator is EQUALS.\n Possible values are: data guard | \n diagnostic pack sqlt | \n tuning pack sqlt | \n ols | \n olap.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type \n is SSM_MANAGED:
\n Application Name - The name of the application.\n Logical operator is EQUALS.
\n Application Publisher - The publisher of the application.\n Logical operator is EQUALS.
\n Application Version - The version of the application.\n Logical operator is EQUALS.
\n Platform Name - The name of the platform.\n Logical operator is EQUALS.
\n Platform Type - The platform type.\n Logical operator is EQUALS.
\n Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.\n
\n AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery.\n Logical operator is NOT_EQUALS.
\n License Included - The type of license included.\n Logical operators are EQUALS and NOT_EQUALS.\n Possible values are: sql-server-enterprise | \n sql-server-standard | \n sql-server-web | \n windows-server-datacenter.
The following filters and logical operators are supported when the resource type\n is RDS:
\n Engine Edition - The edition of the database engine.\n Logical operator is EQUALS.\n Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 \n \t| db2-se | db2-ae.
\n License Pack - The license pack.\n Logical operator is EQUALS.\n Possible values are: data guard | \n diagnostic pack sqlt | \n tuning pack sqlt | \n ols | \n olap.
Tag key.
" + "smithy.api#documentation": "The tag key.
" } }, "Value": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "Tag value.
" + "smithy.api#documentation": "The tag value.
" } } }, "traits": { - "smithy.api#documentation": "Details about a tag for a license configuration.
" + "smithy.api#documentation": "Details about the tags for a resource. For more information about tagging support in\n License Manager, see the TagResource operation.
" } }, "com.amazonaws.licensemanager#TagKeyList": { @@ -7783,7 +7795,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified tags to the specified license configuration.
" + "smithy.api#documentation": "Adds the specified tags to the specified resource. The following resources support\n tagging in License Manager:
\nLicenses
\nGrants
\nLicense configurations
\nReport generators
\nAmazon Resource Name (ARN) of the license configuration.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource. The following examples provide an example\n ARN for each supported resource in License Manager:
\nLicenses -\n arn:aws:license-manager::111122223333:license:l-EXAMPLE2da7646d6861033667f20e895\n
Grants -\n arn:aws:license-manager::111122223333:grant:g-EXAMPLE7b19f4a0ab73679b0beb52707\n
License configurations -\n arn:aws:license-manager:us-east-1:111122223333:license-configuration:lic-EXAMPLE6a788d4c8acd4264ff0ecf2ed2d\n
Report generators -\n arn:aws:license-manager:us-east-1:111122223333:report-generator:r-EXAMPLE825b4a4f8fe5a3e0c88824e5fc6\n
Removes the specified tags from the specified license configuration.
" + "smithy.api#documentation": "Removes the specified tags from the specified resource.
" } }, "com.amazonaws.licensemanager#UntagResourceRequest": { @@ -7940,7 +7952,7 @@ "ResourceArn": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the license configuration.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, @@ -7978,6 +7990,9 @@ { "target": "com.amazonaws.licensemanager#AuthorizationException" }, + { + "target": "com.amazonaws.licensemanager#ConflictException" + }, { "target": "com.amazonaws.licensemanager#InvalidParameterValueException" }, @@ -8181,6 +8196,9 @@ { "target": "com.amazonaws.licensemanager#AuthorizationException" }, + { + "target": "com.amazonaws.licensemanager#ConflictException" + }, { "target": "com.amazonaws.licensemanager#InvalidParameterValueException" }, diff --git a/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json b/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json index 49d16bd7..6314eba5 100644 --- a/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json +++ b/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json @@ -2253,7 +2253,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -2522,7 +2522,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -3801,6 +3801,26 @@ "smithy.api#documentation": "Use Source to identify the format of your input captions. The service cannot auto-detect caption format." } }, + "com.amazonaws.mediaconvert#CaptionSourceUpconvertSTLToTeletext": { + "type": "enum", + "members": { + "UPCONVERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPCONVERT" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext." + } + }, "com.amazonaws.mediaconvert#ChannelMapping": { "type": "structure", "members": { @@ -9521,6 +9541,13 @@ "smithy.api#documentation": "When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.", "smithy.api#jsonName": "timeDeltaUnits" } + }, + "UpconvertSTLToTeletext": { + "target": "com.amazonaws.mediaconvert#CaptionSourceUpconvertSTLToTeletext", + "traits": { + "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext.", + "smithy.api#jsonName": "upconvertSTLToTeletext" + } } }, "traits": { @@ -11020,7 +11047,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -12103,7 +12130,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -20474,7 +20501,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -21661,7 +21688,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -22463,7 +22490,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, @@ -25747,6 +25774,13 @@ "com.amazonaws.mediaconvert#VideoOverlay": { "type": "structure", "members": { + "Crop": { + "target": "com.amazonaws.mediaconvert#VideoOverlayCrop", + "traits": { + "smithy.api#documentation": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height.", + "smithy.api#jsonName": "crop" + } + }, "EndTimecode": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { @@ -25794,6 +25828,49 @@ "smithy.api#documentation": "Overlay one or more videos on top of your input video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-overlays.html" } }, + "com.amazonaws.mediaconvert#VideoOverlayCrop": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the height of the video overlay cropping rectangle. To use the same height as your overlay input video: Keep blank, or enter 0. To specify a different height for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels high. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 108 pixels high.", + "smithy.api#jsonName": "height" + } + }, + "Unit": { + "target": "com.amazonaws.mediaconvert#VideoOverlayUnit", + "traits": { + "smithy.api#documentation": "Specify the Unit type to use when you enter a value for X position, Y position, Width, or Height. You can choose Pixels or Percentage. Leave blank to use the default value, Pixels.", + "smithy.api#jsonName": "unit" + } + }, + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the width of the video overlay cropping rectangle. To use the same width as your overlay input video: Keep blank, or enter 0. To specify a different width for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels wide. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 192 pixels wide.", + "smithy.api#jsonName": "width" + } + }, + "X": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the distance between the cropping rectangle and the left edge of your overlay video's frame. To position the cropping rectangle along the left edge: Keep blank, or enter 0. To position the cropping rectangle to the right, relative to the left edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the left edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 192 pixels from the left edge of the overlay video's frame.", + "smithy.api#jsonName": "x" + } + }, + "Y": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the distance between the cropping rectangle and the top edge of your overlay video's frame. To position the cropping rectangle along the top edge: Keep blank, or enter 0. To position the cropping rectangle down, relative to the top edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the top edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 108 pixels from the top edge of the overlay video's frame.", + "smithy.api#jsonName": "y" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height." + } + }, "com.amazonaws.mediaconvert#VideoOverlayInput": { "type": "structure", "members": { @@ -27559,7 +27636,7 @@ "PerFrameMetrics": { "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", "traits": { - "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", "smithy.api#jsonName": "perFrameMetrics" } }, diff --git a/models/medialive/service/2017-10-14/medialive-2017-10-14.json b/models/medialive/service/2017-10-14/medialive-2017-10-14.json index 46dfbd54..388aff7a 100644 --- a/models/medialive/service/2017-10-14/medialive-2017-10-14.json +++ b/models/medialive/service/2017-10-14/medialive-2017-10-14.json @@ -1718,6 +1718,26 @@ "smithy.api#documentation": "Av1 Look Ahead Rate Control" } }, + "com.amazonaws.medialive#Av1RateControlMode": { + "type": "enum", + "members": { + "CBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBR" + } + }, + "QVBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QVBR" + } + } + }, + "traits": { + "smithy.api#documentation": "Av1 Rate Control Mode" + } + }, "com.amazonaws.medialive#Av1SceneChangeDetect": { "type": "enum", "members": { @@ -1863,6 +1883,20 @@ "smithy.api#documentation": "Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video.", "smithy.api#jsonName": "timecodeBurninSettings" } + }, + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin50000Max8000000", + "traits": { + "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR.", + "smithy.api#jsonName": "bitrate" + } + }, + "RateControlMode": { + "target": "com.amazonaws.medialive#Av1RateControlMode", + "traits": { + "smithy.api#documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.", + "smithy.api#jsonName": "rateControlMode" + } } }, "traits": { @@ -28522,6 +28556,13 @@ "smithy.api#documentation": "SRT settings for an SRT output; one destination for each redundant encoder.", "smithy.api#jsonName": "srtSettings" } + }, + "LogicalInterfaceNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "Optional assignment of an output to a logical interface on the Node. Only applies to on premises channels.", + "smithy.api#jsonName": "logicalInterfaceNames" + } } }, "traits": { @@ -35179,6 +35220,13 @@ "traits": { "smithy.api#jsonName": "dryRun" } + }, + "AnywhereSettings": { + "target": "com.amazonaws.medialive#AnywhereSettings", + "traits": { + "smithy.api#documentation": "The Elemental Anywhere settings for this channel.", + "smithy.api#jsonName": "anywhereSettings" + } } }, "traits": { diff --git a/models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json b/models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json index 24d27e59..451fd773 100644 --- a/models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json +++ b/models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json @@ -947,6 +947,42 @@ "traits": { "smithy.api#documentation": "Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" } + }, + "Profiles": { + "target": "com.amazonaws.mediapackagev2#DashProfiles", + "traits": { + "smithy.api#documentation": "The profile that the output is compliant with.
" + } + }, + "BaseUrls": { + "target": "com.amazonaws.mediapackagev2#DashBaseUrls", + "traits": { + "smithy.api#documentation": "The base URLs to use for retrieving segments.
" + } + }, + "ProgramInformation": { + "target": "com.amazonaws.mediapackagev2#DashProgramInformation", + "traits": { + "smithy.api#documentation": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + } + }, + "DvbSettings": { + "target": "com.amazonaws.mediapackagev2#DashDvbSettings", + "traits": { + "smithy.api#documentation": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + } + }, + "Compactness": { + "target": "com.amazonaws.mediapackagev2#DashCompactness", + "traits": { + "smithy.api#documentation": "The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.
" + } + }, + "SubtitleConfiguration": { + "target": "com.amazonaws.mediapackagev2#DashSubtitleConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for DASH subtitles.
" + } } }, "traits": { @@ -1734,7 +1770,43 @@ "ScteDash": { "AdMarkerDash": "XML" }, - "DrmSignaling": "INDIVIDUAL" + "DrmSignaling": "INDIVIDUAL", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + }, + "Profiles": [ + "DVB_DASH" + ], + "BaseUrls": [ + { + "Url": "http://example.com/", + "ServiceLocation": "A", + "DvbPriority": 1, + "DvbWeight": 3 + } + ], + "ProgramInformation": { + "Title": "exampleTitle", + "Source": "exampleSource", + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example.com/more-information" + }, + "DvbSettings": { + "FontDownload": { + "Url": "https://example.com/fonts/SubtitleDisplay.woff", + "MimeType": "application/font", + "FontFamily": "SubtitleDisplay" + }, + "ErrorMetrics": [ + { + "ReportingUrl": "https://example.com/dvb-errors/errors", + "Probability": 500 + } + ] + }, + "Compactness": "STANDARD" }, { "ManifestName": "exampleDashManifest2", @@ -1752,7 +1824,43 @@ "ScteDash": { "AdMarkerDash": "XML" }, - "DrmSignaling": "INDIVIDUAL" + "DrmSignaling": "INDIVIDUAL", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + }, + "Profiles": [ + "DVB_DASH" + ], + "BaseUrls": [ + { + "Url": "http://example2.com/", + "ServiceLocation": "B", + "DvbPriority": 2, + "DvbWeight": 2 + } + ], + "ProgramInformation": { + "Title": "exampleTitle2", + "Source": "exampleSource2", + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example2.com/more-information" + }, + "DvbSettings": { + "FontDownload": { + "Url": "https://example.com/fonts/SubtitleDisplay.woff", + "MimeType": "application/font", + "FontFamily": "SubtitleDisplay" + }, + "ErrorMetrics": [ + { + "ReportingUrl": "https://example2.com/dvb-errors/errors", + "Probability": 600 + } + ] + }, + "Compactness": "STANDARD" } ], "Tags": { @@ -1867,7 +1975,43 @@ "AdMarkerDash": "XML" }, "DrmSignaling": "INDIVIDUAL", - "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd" + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + }, + "Profiles": [ + "DVB_DASH" + ], + "BaseUrls": [ + { + "Url": "http://example.com/", + "ServiceLocation": "A", + "DvbPriority": 1, + "DvbWeight": 3 + } + ], + "ProgramInformation": { + "Title": "exampleTitle", + "Source": "exampleSource", + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example.com/more-information" + }, + "DvbSettings": { + "FontDownload": { + "Url": "https://example.com/fonts/SubtitleDisplay.woff", + "MimeType": "application/font", + "FontFamily": "SubtitleDisplay" + }, + "ErrorMetrics": [ + { + "ReportingUrl": "https://example.com/dvb-errors/errors", + "Probability": 500 + } + ] + }, + "Compactness": "STANDARD" }, { "ManifestName": "exampleDashManifest2", @@ -1886,7 +2030,43 @@ "AdMarkerDash": "XML" }, "DrmSignaling": "INDIVIDUAL", - "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd" + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + }, + "Profiles": [ + "DVB_DASH" + ], + "BaseUrls": [ + { + "Url": "http://example2.com/", + "ServiceLocation": "B", + "DvbPriority": 2, + "DvbWeight": 2 + } + ], + "ProgramInformation": { + "Title": "exampleTitle2", + "Source": "exampleSource2", + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example2.com/more-information" + }, + "DvbSettings": { + "FontDownload": { + "Url": "https://example.com/fonts/SubtitleDisplay.woff", + "MimeType": "application/font", + "FontFamily": "SubtitleDisplay" + }, + "ErrorMetrics": [ + { + "ReportingUrl": "https://example2.com/dvb-errors/errors", + "Probability": 600 + } + ] + }, + "Compactness": "STANDARD" } ], "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", @@ -2120,6 +2300,84 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#DashBaseUrl": { + "type": "structure", + "members": { + "Url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A source location for segments.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + }, + "ServiceLocation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "DvbPriority": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.
", + "smithy.api#range": { + "min": 1, + "max": 15000 + } + } + }, + "DvbWeight": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.
", + "smithy.api#range": { + "min": 1, + "max": 15000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.
" + } + }, + "com.amazonaws.mediapackagev2#DashBaseUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#DashBaseUrl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.mediapackagev2#DashCompactness": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.mediapackagev2#DashDrmSignaling": { "type": "enum", "members": { @@ -2137,6 +2395,106 @@ } } }, + "com.amazonaws.mediapackagev2#DashDvbErrorMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#DashDvbMetricsReporting" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.mediapackagev2#DashDvbFontDownload": { + "type": "structure", + "members": { + "Url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL for downloading fonts for subtitles.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "MimeType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The mimeType of the resource that's at the font download URL.
For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]$" + } + }, + "FontFamily": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The fontFamily name for subtitles, as described in EBU-TT-D Subtitling Distribution Format.
For use with DVB-DASH profiles only. The settings for font downloads that you want Elemental MediaPackage to pass through to the manifest.
" + } + }, + "com.amazonaws.mediapackagev2#DashDvbMetricsReporting": { + "type": "structure", + "members": { + "ReportingUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL where playback devices send error reports.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + }, + "Probability": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest.
" + } + }, + "com.amazonaws.mediapackagev2#DashDvbSettings": { + "type": "structure", + "members": { + "FontDownload": { + "target": "com.amazonaws.mediapackagev2#DashDvbFontDownload", + "traits": { + "smithy.api#documentation": "Subtitle font settings.
" + } + }, + "ErrorMetrics": { + "target": "com.amazonaws.mediapackagev2#DashDvbErrorMetrics", + "traits": { + "smithy.api#documentation": "Playback device error reporting settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + } + }, "com.amazonaws.mediapackagev2#DashPeriodTrigger": { "type": "enum", "members": { @@ -2184,6 +2542,88 @@ } } }, + "com.amazonaws.mediapackagev2#DashProfile": { + "type": "enum", + "members": { + "DVB_DASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DVB_DASH" + } + } + } + }, + "com.amazonaws.mediapackagev2#DashProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#DashProfile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.mediapackagev2#DashProgramInformation": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title for the manifest.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "Source": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the content provider.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "Copyright": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A copyright statement about the content.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "LanguageCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The language code for this manifest.
", + "smithy.api#length": { + "min": 2, + "max": 5 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$" + } + }, + "MoreInformationUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "An absolute URL that contains more information about this content.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + } + }, "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat": { "type": "enum", "members": { @@ -2195,6 +2635,52 @@ } } }, + "com.amazonaws.mediapackagev2#DashSubtitleConfiguration": { + "type": "structure", + "members": { + "TtmlConfiguration": { + "target": "com.amazonaws.mediapackagev2#DashTtmlConfiguration", + "traits": { + "smithy.api#documentation": "Settings for TTML subtitles.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for DASH subtitles.
" + } + }, + "com.amazonaws.mediapackagev2#DashTtmlConfiguration": { + "type": "structure", + "members": { + "TtmlProfile": { + "target": "com.amazonaws.mediapackagev2#DashTtmlProfile", + "traits": { + "smithy.api#documentation": "The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. \n EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. \n MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.
The settings for TTML subtitles.
" + } + }, + "com.amazonaws.mediapackagev2#DashTtmlProfile": { + "type": "enum", + "members": { + "IMSC_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMSC_1" + } + }, + "EBU_TT_D_101": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBU_TT_D_101" + } + } + } + }, "com.amazonaws.mediapackagev2#DashUtcTiming": { "type": "structure", "members": { @@ -3378,6 +3864,42 @@ "traits": { "smithy.api#documentation": "Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" } + }, + "Profiles": { + "target": "com.amazonaws.mediapackagev2#DashProfiles", + "traits": { + "smithy.api#documentation": "The profile that the output is compliant with.
" + } + }, + "BaseUrls": { + "target": "com.amazonaws.mediapackagev2#DashBaseUrls", + "traits": { + "smithy.api#documentation": "The base URL to use for retrieving segments.
" + } + }, + "ProgramInformation": { + "target": "com.amazonaws.mediapackagev2#DashProgramInformation", + "traits": { + "smithy.api#documentation": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + } + }, + "DvbSettings": { + "target": "com.amazonaws.mediapackagev2#DashDvbSettings", + "traits": { + "smithy.api#documentation": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + } + }, + "Compactness": { + "target": "com.amazonaws.mediapackagev2#DashCompactness", + "traits": { + "smithy.api#documentation": "The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
The configuration for DASH subtitles.
" + } } }, "traits": { @@ -8114,6 +8636,30 @@ "traits": { "smithy.api#enumValue": "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION" } + }, + "INCOMPATIBLE_DASH_PROFILE_DVB_DASH_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPATIBLE_DASH_PROFILE_DVB_DASH_CONFIGURATION" + } + }, + "DASH_DVB_ATTRIBUTES_WITHOUT_DVB_DASH_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASH_DVB_ATTRIBUTES_WITHOUT_DVB_DASH_PROFILE" + } + }, + "INCOMPATIBLE_DASH_COMPACTNESS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPATIBLE_DASH_COMPACTNESS_CONFIGURATION" + } + }, + "INCOMPATIBLE_XML_ENCODING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPATIBLE_XML_ENCODING" + } } } }, diff --git a/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json b/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json index 1689aabb..a5af161c 100644 --- a/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json +++ b/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json @@ -7,7 +7,7 @@ "AccessType": { "target": "com.amazonaws.mediatailor#AccessType", "traits": { - "smithy.api#documentation": "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
\n S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
\u2022 You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\n\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\n\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
\n\n AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
\u2022 You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
\u2022 Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\n\u2022 The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
\u2022 You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
\u2022 You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
\u2022 You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
\u2022 Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\u2022 The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
\u2022 You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
" + "smithy.api#documentation": "Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
" } }, "AdBreakMetadata": { @@ -127,7 +127,7 @@ "StreamingMediaFileConditioning": { "target": "com.amazonaws.mediatailor#StreamingMediaFileConditioning", "traits": { - "smithy.api#documentation": "For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. \n TRANSCODE indicates that MediaTailor must transcode the ads. \n NONE indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. \n For more information about ad conditioning see Using preconditioned ads in the Elemental MediaTailor user guide.
For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. TRANSCODE indicates that MediaTailor must transcode the ads. NONE indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see Using preconditioned ads in the Elemental MediaTailor user guide.
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).
\nFor more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types\n in Elemental MediaTailor User Guide.
" + "smithy.api#documentation": "Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).
For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types in Elemental MediaTailor User Guide.
" } }, "com.amazonaws.mediatailor#AdsInteractionPublishOptInEventType": { @@ -601,7 +601,7 @@ "DynamicVariable": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
\nYou can include up to 100 dynamic variables.
", + "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
", "smithy.api#required": {} } }, @@ -614,7 +614,7 @@ } }, "traits": { - "smithy.api#documentation": "MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
\nAs an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to \n send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in Enable logging from AWS services, Logging that requires additional permissions [V2].
" + "smithy.api#documentation": "The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in Enable logging from AWS services, Logging that requires additional permissions [V2].
" } }, "AdsInteractionLog": { @@ -1129,7 +1129,7 @@ "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { - "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
The type of playback mode to use for this channel.
\n\n LINEAR - The programs in the schedule play once back-to-back in the schedule.
\n LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the schedule.
LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
\n The time-shifted viewing configuration you want to associate to the channel.\n
" + "smithy.api#documentation": "The time-shifted viewing configuration you want to associate to the channel.
" } }, "Audiences": { @@ -1246,7 +1246,7 @@ "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { - "smithy.api#documentation": "\n The time-shifted viewing configuration assigned to the channel.\n
" + "smithy.api#documentation": "The time-shifted viewing configuration assigned to the channel.
" } }, "Audiences": { @@ -1416,7 +1416,7 @@ "ScheduleType": { "target": "com.amazonaws.mediatailor#PrefetchScheduleType", "traits": { - "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.\n
" + "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
" } }, "StreamId": { @@ -2373,7 +2373,7 @@ "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { - "smithy.api#documentation": "\n The time-shifted viewing configuration for the channel.\n
" + "smithy.api#documentation": "The time-shifted viewing configuration for the channel.
" } }, "Audiences": { @@ -2882,7 +2882,7 @@ "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING \n indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
Settings for customizing what events are included in logs for interactions with the origin server.
\nFor more information about manifest service logs, including descriptions of the event types, see MediaTailor manifest logs description and event types\n in Elemental MediaTailor User Guide.
" + "smithy.api#documentation": "Settings for customizing what events are included in logs for interactions with the origin server.
For more information about manifest service logs, including descriptions of the event types, see MediaTailor manifest logs description and event types in Elemental MediaTailor User Guide.
" } }, "com.amazonaws.mediatailor#MaxResults": { @@ -4340,7 +4342,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
\nThrough the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
", + "smithy.api#documentation": "Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
", "smithy.api#title": "AWS MediaTailor", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5334,7 +5336,7 @@ "DynamicVariables": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { - "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
\nYou initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.\n
" + "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
" } }, "RecurringPrefetchConfiguration": { @@ -5887,7 +5889,7 @@ } }, "traits": { - "smithy.api#documentation": "With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following\n configurations describe the MediaTailor behavior when prefetching ads for a live event.
" + "smithy.api#documentation": "With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following configurations describe the MediaTailor behavior when prefetching ads for a live event.
" } }, "com.amazonaws.mediatailor#RelativePosition": { @@ -6250,7 +6252,7 @@ } }, "traits": { - "smithy.api#documentation": "The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
\n segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
\n The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, \n and the maximum allowed maximum time delay is 21600 seconds (6 hours).\n
", + "smithy.api#documentation": "The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n The configuration for time-shifted viewing.\n
" + "smithy.api#documentation": "The configuration for time-shifted viewing.
" } }, "com.amazonaws.mediatailor#TimeSignalMessage": { @@ -6588,7 +6590,7 @@ } }, "traits": { - "smithy.api#documentation": "The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.
The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).
See the time_signal() table of the 2022 SCTE-35 specification for more information.
The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.
The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).
See the time_signal() table of the 2022 SCTE-35 specification for more information.
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
\n ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR\n PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
\nIf there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
\n RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
\n The time-shifted viewing configuration you want to associate to the channel.\n
" + "smithy.api#documentation": "The time-shifted viewing configuration you want to associate to the channel.
" } }, "Audiences": { @@ -6803,7 +6805,7 @@ "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { - "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
\n The time-shifted viewing configuration for the channel.\n
" + "smithy.api#documentation": "The time-shifted viewing configuration for the channel.
" } }, "Audiences": { diff --git a/models/neptune/service/2014-10-31/neptune-2014-10-31.json b/models/neptune/service/2014-10-31/neptune-2014-10-31.json index c650c46b..73b88ae8 100644 --- a/models/neptune/service/2014-10-31/neptune-2014-10-31.json +++ b/models/neptune/service/2014-10-31/neptune-2014-10-31.json @@ -397,6 +397,9 @@ }, { "target": "com.amazonaws.neptune#StopDBCluster" + }, + { + "target": "com.amazonaws.neptune#SwitchoverGlobalCluster" } ], "traits": { @@ -1688,7 +1691,7 @@ "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "The storage type for the DB cluster.
" + "smithy.api#documentation": "The pending change in storage type for the DB cluster. \u00a0 Valid Values:
\n\n \n standard\n \u00a0 \u2013 \u00a0\n ( the default ) Configures cost-effective database storage for applications\n with moderate to small I/O usage.
\n \n iopt1\n \u00a0 \u2013 \u00a0\n Enables I/O-Optimized storage\n that's designed to meet the needs of I/O-intensive graph workloads that\n require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
\nThe Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters.
" } } }, @@ -2229,7 +2232,7 @@ "EngineVersion": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use for the new DB cluster.
\nExample: 1.0.2.1\n
The version number of the database engine to use for the new DB cluster.
\nExample: 1.2.1.0\n
The storage type to associate with the DB cluster.
\nValid Values:
\n\n standard | iopt1\n
Default:
\n\n standard\n
When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to standard.
The storage type for the new DB cluster.
\nValid Values:
\n\n \n standard\n \u00a0 \u2013 \u00a0\n ( the default ) Configures cost-effective database storage for applications\n with moderate to small I/O usage. When set to standard, the storage type\n is not returned in the response.
\n \n iopt1\n \u00a0 \u2013 \u00a0\n Enables I/O-Optimized storage\n that's designed to meet the needs of I/O-intensive graph workloads that\n require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
\nSpecifies the storage type to be associated with the DB instance.
\nNot applicable. Storage is managed by the DB Cluster.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "TdeCredentialArn": { @@ -3443,7 +3446,7 @@ "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "The storage type associated with the DB cluster.
" + "smithy.api#documentation": "The storage type used by the DB cluster.
\nValid Values:
\n\n \n standard\n \u00a0 \u2013 \u00a0\n ( the default ) Provides cost-effective database storage for applications\n with moderate to small I/O usage.
\n \n iopt1\n \u00a0 \u2013 \u00a0\n Enables I/O-Optimized storage\n that's designed to meet the needs of I/O-intensive graph workloads that\n require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
\n An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
n optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
Specifies the storage type associated with DB instance.
" + "smithy.api#documentation": "Specifies the storage type associated with the DB instance.
" } }, "TdeCredentialArn": { @@ -5787,13 +5790,13 @@ "MaxRecords": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response\n so you can retrieve the remaining results.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n
An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the secondary Neptune DB cluster\n that you want to promote to primary for the global database.
", "smithy.api#required": {} } + }, + "AllowDataLoss": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies whether to allow data loss for this global database cluster operation.\n Allowing data loss triggers a global failover operation.
\nIf you don't specify AllowDataLoss, the global database cluster operation\n defaults to a switchover.
Constraints:Can't be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
\nConstraints:Can't be specified together with the AllowDataLoss parameter.
The current status of the global cluster. Possible values are as follows:
\npending \u0096 The service received a request to switch over or fail over the global cluster. The\n global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation\n starts.
\nfailing-over \u0096 Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
\ncancelling \u0096 The request to switch over or fail over the global cluster was cancelled and the primary\n Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
\nswitching-over \u0096 This status covers the range of Neptune internal operations that take place during the switchover process, such\n as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
\nThe Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this\n state.
" + } + }, + "ToDbClusterArn": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated\n with this state.
" + } + }, + "IsDataLossAllowed": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover.\n Otherwise, it's a switchover.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the state of scheduled or in-process operations on a\n global cluster (Neptune global database). This data type is empty unless a switchover\n or failover operation is scheduled or is in progress on the Neptune global database.
" + } + }, + "com.amazonaws.neptune#FailoverStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILING_OVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing-over" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + } + } + }, "com.amazonaws.neptune#Filter": { "type": "structure", "members": { @@ -7684,6 +7754,12 @@ "traits": { "smithy.api#documentation": "A list of cluster ARNs and instance ARNs for all the DB clusters\n that are part of the global database.
" } + }, + "FailoverState": { + "target": "com.amazonaws.neptune#FailoverState", + "traits": { + "smithy.api#documentation": "A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database).\n This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
The storage type to associate with the DB cluster.
\nValid Values:
\n\n standard | iopt1\n
Default:
\n\n standard\n
The storage type to associate with the DB cluster.
\nValid Values:
\n\n \n standard\n \u00a0 \u2013 \u00a0\n ( the default ) Configures cost-effective database storage for applications\n with moderate to small I/O usage.
\n \n iopt1\n \u00a0 \u2013 \u00a0\n Enables I/O-Optimized storage\n that's designed to meet the needs of I/O-intensive graph workloads that\n require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
\nNot supported.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "TdeCredentialArn": { @@ -9387,7 +9463,7 @@ "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "Indicates the storage type for a DB instance.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "SupportsIops": { @@ -9735,7 +9811,7 @@ "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB instance.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "CACertificateIdentifier": { @@ -11196,6 +11272,67 @@ } } }, + "com.amazonaws.neptune#SwitchoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#SwitchoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#SwitchoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "Switches over the specified secondary DB cluster to be the new primary DB cluster in the global\n database cluster. Switchover operations were previously called \"managed planned failovers.\"
\nPromotes the specified secondary cluster to assume full read/write capabilities and demotes the current\n primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary\n clusters are synchronized with the primary at the beginning of the process so the new primary continues operations\n for the global database without losing any data. Your database is unavailable for a short time while the primary\n and selected secondary clusters are assuming their new roles.
\nThis operation is intended for controlled environments, for operations such as \"regional rotation\" or\n to fall back to the original primary after a global database failover.
\nThe identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
\nConstraints: Must match the identifier of an existing global database cluster.
", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for\n the global database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptune#SwitchoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptune#TStamp": { "type": "timestamp" }, @@ -11320,30 +11457,30 @@ "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "The valid storage types for your DB instance. For example, gp2, io1.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "StorageSize": { "target": "com.amazonaws.neptune#RangeList", "traits": { - "smithy.api#documentation": "The valid range of storage in gibibytes. For example, 100 to 16384.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "ProvisionedIops": { "target": "com.amazonaws.neptune#RangeList", "traits": { - "smithy.api#documentation": "The valid range of provisioned IOPS. For example, 1000-20000.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "IopsToStorageRatio": { "target": "com.amazonaws.neptune#DoubleRangeList", "traits": { - "smithy.api#documentation": "The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } } }, "traits": { - "smithy.api#documentation": "Information about valid modifications that you can make to your DB\n instance.
\nContains the result of a successful call to the DescribeValidDBInstanceModifications action.
" + "smithy.api#documentation": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "com.amazonaws.neptune#ValidStorageOptionsList": { diff --git a/models/oam/service/2022-06-10/oam-2022-06-10.json b/models/oam/service/2022-06-10/oam-2022-06-10.json index 334f383a..32abdd27 100644 --- a/models/oam/service/2022-06-10/oam-2022-06-10.json +++ b/models/oam/service/2022-06-10/oam-2022-06-10.json @@ -58,7 +58,7 @@ "aws:RequestTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, \n data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters\n that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
\nBefore you create a link, you must create a sink in the monitoring account and create a\n sink policy in that account. The sink policy must permit the source account to link to it. You\n can grant permission to source accounts by granting permission to an entire organization or to\n individual accounts.
\nFor more information, see \n CreateSink and\n PutSinkPolicy.
\nEach monitoring account can be linked to as many as 100,000 source accounts.
\nEach source account can be linked to as many as five monitoring accounts.
", + "smithy.api#documentation": "Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.
For more information, see CreateSink and PutSinkPolicy.
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
", "smithy.api#http": { "method": "POST", "uri": "/CreateLink" @@ -71,34 +71,34 @@ "LabelTemplate": { "target": "com.amazonaws.oam#LabelTemplate", "traits": { - "smithy.api#documentation": "Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring\n account.
\nYou can use a custom label or use the following variables:
\n\n $AccountName is the name of the account
\n $AccountEmail is the globally unique email address of the account
\n $AccountEmailNoDomain is the email address of the account without the domain name
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the $AccountName, $AccountEmail, and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.
An array of strings that define which types of data that the source account shares with the monitoring \n account.
", + "smithy.api#documentation": "An array of strings that define which types of data that the source account shares with the monitoring account.
", "smithy.api#required": {} } }, "SinkIdentifier": { "target": "com.amazonaws.oam#ResourceIdentifier", "traits": { - "smithy.api#documentation": "The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
\nFor more information about sinks, see \n CreateSink.
", + "smithy.api#documentation": "The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.
For more information about sinks, see CreateSink.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
" } }, "LinkConfiguration": { "target": "com.amazonaws.oam#LinkConfiguration", "traits": { - "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
" } } }, @@ -124,7 +124,7 @@ "Label": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The label that you assigned to this link. If the labelTemplate includes variables, \n this field displays the variables resolved to their actual values.
The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.
This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" } } }, @@ -192,7 +192,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be\n used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that\n represents an attachment point in a monitoring account. Source accounts can link to the sink\n to send observability data.
\nAfter you create a sink, you must create a sink policy that allows source accounts to attach to it. \n For more information, see PutSinkPolicy.
\nEach account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
", + "smithy.api#documentation": "Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.
Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
", "smithy.api#http": { "method": "POST", "uri": "/CreateSink" @@ -212,7 +212,7 @@ "Tags": { "target": "com.amazonaws.oam#TagMapInput", "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nFor more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
" } } }, @@ -278,7 +278,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Deletes a link between a monitoring account sink and a source account. You must run this operation\n in the source account.
", + "smithy.api#documentation": "Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteLink" @@ -391,7 +391,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns complete information about one link.
\nTo use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
", + "smithy.api#documentation": "Returns complete information about one link.
To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
", "smithy.api#http": { "method": "POST", "uri": "/GetLink" @@ -408,6 +408,12 @@ "smithy.api#documentation": "The ARN of the link to retrieve information for.
", "smithy.api#required": {} } + }, + "IncludeTags": { + "target": "com.amazonaws.oam#IncludeTags", + "traits": { + "smithy.api#documentation": "Specifies whether to include the tags associated with the link in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" } } }, @@ -496,7 +502,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns complete information about one monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
", + "smithy.api#documentation": "Returns complete information about one monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
", "smithy.api#http": { "method": "POST", "uri": "/GetSink" @@ -513,6 +519,12 @@ "smithy.api#documentation": "The ARN of the sink to retrieve information for.
", "smithy.api#required": {} } + }, + "IncludeTags": { + "target": "com.amazonaws.oam#IncludeTags", + "traits": { + "smithy.api#documentation": "Specifies whether to include the tags associated with the sink in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
Returns the current sink policy attached to this sink. The sink policy specifies what \n accounts can attach to this sink as source accounts, and what types of data they can share.
", + "smithy.api#documentation": "Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
", "smithy.api#http": { "method": "POST", "uri": "/GetSinkPolicy" @@ -626,6 +638,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.oam#IncludeTags": { + "type": "boolean" + }, "com.amazonaws.oam#InternalServiceFault": { "type": "structure", "members": { @@ -681,18 +696,18 @@ "LogGroupConfiguration": { "target": "com.amazonaws.oam#LogGroupConfiguration", "traits": { - "smithy.api#documentation": "Use this structure to filter which log groups are to send log events from \n the source account to the monitoring account.
" + "smithy.api#documentation": "Use this structure to filter which log groups are to send log events from the source account to the monitoring account.
" } }, "MetricConfiguration": { "target": "com.amazonaws.oam#MetricConfiguration", "traits": { - "smithy.api#documentation": "Use this structure to filter which metric namespaces are to be shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
" } } }, "traits": { - "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
" } }, "com.amazonaws.oam#ListAttachedLinks": { @@ -721,7 +736,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "Returns a list of source account links that are linked to this monitoring account sink.
\nTo use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
\nTo find a list of links for one source account, use ListLinks.
", + "smithy.api#documentation": "Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
", "smithy.api#http": { "method": "POST", "uri": "/ListAttachedLinks" @@ -786,7 +801,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that contains information about one link attached to this monitoring \n account sink.
" + "smithy.api#documentation": "A structure that contains information about one link attached to this monitoring account sink.
" } }, "com.amazonaws.oam#ListAttachedLinksItems": { @@ -845,7 +860,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that\n this source account has.
\nTo find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", + "smithy.api#documentation": "Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", "smithy.api#http": { "method": "POST", "uri": "/ListLinks" @@ -1104,7 +1119,7 @@ "ResourceArn": { "target": "com.amazonaws.oam#Arn", "traits": { - "smithy.api#documentation": "The ARN of the resource that you want to view tags for.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
\nUnlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags\n for links or sinks you must have the oam:RequestTag permission. The\n aws:ReguestTag permission does not allow you to tag and untag links and\n sinks.
The ARN of the resource that you want to view tags for.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
Unlike tagging permissions in other Amazon Web Services services, to retrieve the list of tags for links or sinks you must have the oam:RequestTag permission. The aws:ReguestTag permission does not allow you to tag and untag links and sinks.
Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or\n more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive.\n Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
\n = and !=\n
\n AND\n
\n OR\n
\n LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end\n of the string that you want to search for and include.
\n IN and NOT IN, using parentheses ( )\n
Examples:
\n\n LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and \n Other-Log-Group.
\n LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and \n Private-Log-Group-2.
\n LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or \n AWSLogs.
If you are updating a link that uses filters, you can specify * as the only value for the \n filter parameter to delete the filter and share all log groups with the monitoring account.
Use this field to specify which log groups are to share their log events with the monitoring account. Use the term LogGroupName and one or more of the following operands. Use single quotation marks (') around log group names. The matching of log group names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
= and !=
AND
OR
LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
IN and NOT IN, using parentheses ( )
Examples:
LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log groups with names This-Log-Group and Other-Log-Group.
LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes all log groups except the log groups with names Private-Log-Group and Private-Log-Group-2.
LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes all log groups that have names that start with aws/lambda/ or AWSLogs.
If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all log groups with the monitoring account.
This structure contains the Filter parameter which you can use to specify which log groups are to \n share log events from this source account to the monitoring account.
This structure contains the Filter parameter which you can use to specify which log groups are to share log events from this source account to the monitoring account.
Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or\n more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive.\n Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
\n = and !=\n
\n AND\n
\n OR\n
\n LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end\n of the string that you want to search for and include.
\n IN and NOT IN, using parentheses ( )\n
Examples:
\n\n Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces.
\n Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.
\n Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
If you are updating a link that uses filters, you can specify * as the only value for the \n filter parameter to delete the filter and share all metric namespaces with the monitoring account.
Use this field to specify which metrics are to be shared with the monitoring account. Use the term Namespace and one or more of the following operands. Use single quotation marks (') around namespace names. The matching of namespace names is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are AND and OR.
= and !=
AND
OR
LIKE and NOT LIKE. These can be used only as prefix searches. Include a % at the end of the string that you want to search for and include.
IN and NOT IN, using parentheses ( )
Examples:
Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with AWS/, such as custom namespaces.
Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.
Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 namespace and your custom namespaces.
If you are updating a link that uses filters, you can specify * as the only value for the filter parameter to delete the filter and share all metric namespaces with the monitoring account.
This structure contains the Filter parameter which you can use to specify which metric namespaces are to \n be shared from this source account to the monitoring account.
This structure contains the Filter parameter which you can use to specify which metric namespaces are to be shared from this source account to the monitoring account.
Creates or updates the resource policy that grants permissions to source\n accounts to link to the monitoring account sink. When you create a sink policy, you can grant\n permissions to all accounts in an organization or to individual accounts.
\nYou can also use a sink policy to limit the types of data that is shared. The three types that \n you can allow or deny are:
\n\n Metrics - Specify with\n AWS::CloudWatch::Metric\n
\n Log groups - Specify with AWS::Logs::LogGroup\n
\n Traces - Specify with AWS::XRay::Trace\n
\n Application Insights - Applications - Specify with AWS::ApplicationInsights::Application\n
See the examples in this section to see how to specify permitted source accounts and data types.
", + "smithy.api#documentation": "Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The six types of services with their respective resource types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
Internet Monitor - Specify with AWS::InternetMonitor::Monitor
Application Signals - Specify with AWS::ApplicationSignals::Service and AWS::ApplicationSignals::ServiceLevelObjective
See the examples in this section to see how to specify permitted source accounts and data types.
", "smithy.api#http": { "method": "POST", "uri": "/PutSinkPolicy" @@ -1245,7 +1260,7 @@ "Policy": { "target": "com.amazonaws.oam#SinkPolicy", "traits": { - "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is\n replaced by what you specify here.
\nThe policy must be in JSON string format with quotation marks escaped and no newlines.
\nFor examples of different types of policies, see the Examples section on this page.
", + "smithy.api#documentation": "The JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
The policy must be in JSON string format with quotation marks escaped and no newlines.
For examples of different types of policies, see the Examples section on this page.
", "smithy.api#required": {} } } @@ -1466,7 +1481,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified resource. \n Both sinks and links can be tagged.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:ResourceTag permission does not allow you to tag and untag links and\n sinks.
Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.
The ARN of the resource that you're adding tags to.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1548,7 +1563,7 @@ "aws.iam#conditionKeys": [ "aws:TagKeys" ], - "smithy.api#documentation": "Removes one or more tags from the specified resource.
\nUnlike tagging permissions in other Amazon Web Services services, to tag or untag links and\n sinks you must have the oam:ResourceTag permission. The\n iam:TagResource permission does not allow you to tag and untag links and\n sinks.
Removes one or more tags from the specified resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.
The ARN of the resource that you're removing tags from.
\nThe ARN format of a sink is \n arn:aws:oam:Region:account-id:sink/sink-id\n \n
The ARN format of a link is \n arn:aws:oam:Region:account-id:link/link-id\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", + "smithy.api#documentation": "The ARN of the resource that you're removing tags from.
The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1614,7 +1629,7 @@ "aws:ResourceTag/${TagKey}", "oam:ResourceTypes" ], - "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked\n monitoring account sink. You can't change the sink or change the monitoring account with this operation.
\nWhen you update a link, you can optionally specify filters\n that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
\nTo update the list of tags associated with the sink, use \n TagResource.
", + "smithy.api#documentation": "Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
To update the list of tags associated with the sink, use TagResource.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateLink" @@ -1634,14 +1649,20 @@ "ResourceTypes": { "target": "com.amazonaws.oam#ResourceTypesInput", "traits": { - "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring \n account.
\nYour input here replaces the current set of data types that are shared.
", + "smithy.api#documentation": "An array of strings that define which types of data that the source account will send to the monitoring account.
Your input here replaces the current set of data types that are shared.
", "smithy.api#required": {} } }, "LinkConfiguration": { "target": "com.amazonaws.oam#LinkConfiguration", "traits": { - "smithy.api#documentation": "Use this structure to filter which metric namespaces and which log groups are to be shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account.
" + } + }, + "IncludeTags": { + "target": "com.amazonaws.oam#IncludeTags", + "traits": { + "smithy.api#documentation": "Specifies whether to include the tags associated with the link in the response after the update operation. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
This structure includes filters that specify which metric namespaces and which log groups are shared from \n the source account to the monitoring account.
" + "smithy.api#documentation": "This structure includes filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
" } } }, @@ -1812,7 +1833,7 @@ "X-Amz-Requested-Operation" ] }, - "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and\n monitoring accounts by using CloudWatch cross-account observability. With\n CloudWatch cross-account observability, you can monitor and troubleshoot applications that span\n multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics,\n logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
\nSet up one or more Amazon Web Services accounts as monitoring\n accounts and link them with multiple source accounts. A\n monitoring account is a central Amazon Web Services account that can view and interact with\n observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it.\n Source accounts share their observability data with the monitoring account. The shared\n observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors\n in CloudWatch Internet Monitor.
\nWhen you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. \n And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.\n
", + "smithy.api#documentation": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
", "smithy.api#title": "CloudWatch Observability Access Manager", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/models/pcs/service/2023-02-10/pcs-2023-02-10.json b/models/pcs/service/2023-02-10/pcs-2023-02-10.json index dd79792e..63b0fd00 100644 --- a/models/pcs/service/2023-02-10/pcs-2023-02-10.json +++ b/models/pcs/service/2023-02-10/pcs-2023-02-10.json @@ -56,7 +56,7 @@ "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" ] }, - "smithy.api#documentation": "Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for\n you to run and scale your high performance computing (HPC) workloads,\n and build scientific and engineering models on Amazon Web Services using Slurm. \n For more information, see \n the Amazon Web Services Parallel Computing Service\n User Guide.
\nThis reference describes the actions and data types of the service management API. You can use the\n Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API\n actions manually. These API actions manage the service through an Amazon Web Services account.
\nThe API actions operate on Amazon Web Services PCS resources. A resource is\n an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use\n the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute\n node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
\nAn Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch\n compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch\n compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes.\n Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources\n related to those compute nodes.
", + "smithy.api#documentation": "Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Amazon Web Services Parallel Computing Service User Guide.
This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.
The API actions operate on Amazon Web Services PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.
An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.
", "smithy.api#title": "AWS Parallel Computing Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -735,11 +735,78 @@ } }, "traits": { - "smithy.api#documentation": "You don't have permission to perform the action.
\n\n Examples\n
\nThe launch template instance profile doesn't pass iam:PassRole\n verification.
There is a mismatch between the account ID and cluster ID.
\nThe cluster ID doesn't exist.
\nThe EC2 instance isn't present.
\nYou don't have permission to perform the action.
Examples
The launch template instance profile doesn't pass iam:PassRole verification.
There is a mismatch between the account ID and cluster ID.
The cluster ID doesn't exist.
The EC2 instance isn't present.
The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
" + } + }, + "com.amazonaws.pcs#AccountingMode": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.pcs#AccountingRequest": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.pcs#AccountingMode", + "traits": { + "smithy.api#documentation": "The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
" + } + }, "com.amazonaws.pcs#AmiId": { "type": "string", "traits": { @@ -793,7 +860,7 @@ "status": { "target": "com.amazonaws.pcs#ClusterStatus", "traits": { - "smithy.api#documentation": "The provisioning status of the cluster.
\nThe provisioning status doesn't indicate the overall health of the cluster.
\nThe provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The size of the cluster.
\n\n SMALL: 32 compute nodes and 256 jobs
\n MEDIUM: 512 compute nodes and 8192 jobs
\n LARGE: 2048 compute nodes and 16,384 jobs
The size of the cluster.
SMALL: 32 compute nodes and 256 jobs
MEDIUM: 512 compute nodes and 8192 jobs
LARGE: 2048 compute nodes and 16,384 jobs
The time (in seconds) before an idle node is scaled down.
\nDefault: 600\n
The time (in seconds) before an idle node is scaled down.
Default: 600
The shared Slurm key for authentication, also known as the cluster secret.
" } + }, + "accounting": { + "target": "com.amazonaws.pcs#Accounting", + "traits": { + "smithy.api#documentation": "The accounting configuration includes configurable settings for Slurm accounting.
" + } } }, "traits": { @@ -958,7 +1031,7 @@ "scaleDownIdleTimeInSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The time (in seconds) before an idle node is scaled down.
\nDefault: 600\n
The time (in seconds) before an idle node is scaled down.
Default: 600
Additional Slurm-specific configuration that directly maps to Slurm settings.
" } + }, + "accounting": { + "target": "com.amazonaws.pcs#AccountingRequest", + "traits": { + "smithy.api#documentation": "The accounting configuration includes configurable settings for Slurm accounting.
" + } } }, "traits": { @@ -1065,7 +1144,7 @@ "status": { "target": "com.amazonaws.pcs#ClusterStatus", "traits": { - "smithy.api#documentation": "The provisioning status of the cluster.
\nThe provisioning status doesn't indicate the overall health of the cluster.
\nThe provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The provisioning status of the compute node group.
\nThe provisioning status doesn't indicate the overall health of the compute node\n group.
\nThe provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.\n If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" } }, "subnetIds": { "target": "com.amazonaws.pcs#SubnetIdList", "traits": { - "smithy.api#documentation": "The list of subnet IDs where instances are provisioned by the compute node group. \n The subnets must be in the same VPC as the cluster.
", + "smithy.api#documentation": "The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
", "smithy.api#required": {} } }, "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" } }, "customLaunchTemplate": { @@ -1156,7 +1235,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.
\n Examples\n
\n\n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n
\n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
The provisioning status of the compute node group.
\nThe provisioning status doesn't indicate the overall health of the compute node\n group.
\nThe provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
\n The unique identifier of the resource that caused the conflict exception.\n
", + "smithy.api#documentation": "The unique identifier of the resource that caused the conflict exception.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The type or category of the resource that caused the conflict exception.\"\n
", + "smithy.api#documentation": "The type or category of the resource that caused the conflict exception.\"
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform more\n than 1 operation on the same resource at the same time.
\n\n Examples\n
\nA cluster with the same name already exists.
\nA cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has\n ACTIVE node groups or queues.
A queue already exists in a cluster.
\nYour request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.
Examples
A cluster with the same name already exists.
A cluster isn't in ACTIVE status.
A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.
A queue already exists in a cluster.
Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a\n service-owned account. The cluster controller communicates with the cluster resources in\n your account. The subnets and security groups for the cluster must already exist before you\n use this API action.
\nIt takes time for Amazon Web Services PCS to create the cluster. The cluster is in\n a Creating state until it is ready to use. There can only be 1\n cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account.\n CreateCluster\n fails with a ServiceQuotaExceededException if there is already\n a cluster in a Creating state.
Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.
It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.
A name to identify the cluster. Example: MyCluster\n
A name to identify the cluster. Example: MyCluster
A value that determines the maximum number of compute nodes in the cluster and the\n maximum number of jobs (active and queued).
\n\n SMALL: 32 compute nodes and 256 jobs
\n MEDIUM: 512 compute nodes and 8192 jobs
\n LARGE: 2048 compute nodes and 16,384 jobs
A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).
SMALL: 32 compute nodes and 256 jobs
MEDIUM: 512 compute nodes and 8192 jobs
LARGE: 2048 compute nodes and 16,384 jobs
A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.pcs#RequestTagMap", "traits": { - "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
" } } }, @@ -1589,7 +1668,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "Creates a managed set of compute nodes. You associate a compute node group with a\n cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node\n group includes the definition of the compute properties and lifecycle management.\n Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in\n your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive\n billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must\n already have a launch template before you call this API. For more information, see Launch an\n instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances.
", + "smithy.api#documentation": "Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "ComputeNodeGroup" @@ -1610,27 +1689,27 @@ "target": "com.amazonaws.pcs#ComputeNodeGroupName", "traits": { "aws.iam#conditionKeyValue": "pcs:ResourceName", - "smithy.api#documentation": "A name to identify the cluster. Example: MyCluster\n
A name to identify the cluster. Example: MyCluster
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes\n (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified\n in the custom launch template.
" + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" } }, "subnetIds": { "target": "com.amazonaws.pcs#StringList", "traits": { - "smithy.api#documentation": "The list of subnet IDs where the compute node group launches instances.\n Subnets must be in the same VPC as the cluster.
", + "smithy.api#documentation": "The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
", "smithy.api#required": {} } }, "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" } }, "customLaunchTemplate": { @@ -1642,7 +1721,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.
\n Examples\n
\n\n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n
\n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.pcs#RequestTagMap", "traits": { - "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
" } } }, @@ -1734,7 +1813,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "Creates a job queue. You must associate 1 or more compute node groups with the queue.\n You can associate 1 compute node group with multiple queues.
", + "smithy.api#documentation": "Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Queue" @@ -1762,20 +1841,20 @@ "computeNodeGroupConfigurations": { "target": "com.amazonaws.pcs#ComputeNodeGroupConfigurationList", "traits": { - "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues\n assign jobs to associated compute node groups.
" + "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
" } }, "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.pcs#RequestTagMap", "traits": { - "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
" } } }, @@ -1800,7 +1879,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ID of the EC2 launch template to use to provision instances.
\n Example: lt-xxxx\n
The ID of the EC2 launch template to use to provision instances.
Example: lt-xxxx
Deletes a cluster and all its linked resources. You must delete all queues and compute\n node groups associated with the cluster before you can delete the cluster.
", + "smithy.api#documentation": "Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Cluster" @@ -1865,7 +1944,7 @@ "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } } @@ -1910,7 +1989,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a compute node group. You must delete all queues associated with the compute\n node group first.
", + "smithy.api#documentation": "Deletes a compute node group. You must delete all queues associated with the compute node group first.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "ComputeNodeGroup" @@ -1937,7 +2016,7 @@ "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } } @@ -1982,7 +2061,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a job queue. If the compute node group associated with this queue isn't\n associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this\n queue.
", + "smithy.api#documentation": "Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Queue" @@ -2009,7 +2088,7 @@ "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } } @@ -2038,20 +2117,20 @@ "privateIpAddress": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The endpoint's private IP address.
\nExample: 2.2.2.2\n
The endpoint's private IP address.
Example: 2.2.2.2
The endpoint's public IP address.
\nExample: 1.1.1.1\n
The endpoint's public IP address.
Example: 1.1.1.1
The endpoint's connection port number.
\n Example: 1234\n
The endpoint's connection port number.
Example: 1234
Returns detailed information about a running cluster in your account. This API action\n provides networking information, endpoint information for communication with the scheduler,\n and provisioning status.
", + "smithy.api#documentation": "Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.
", "smithy.api#readonly": {}, "smithy.api#tags": [ "Cluster" @@ -2220,7 +2299,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed information about a compute node group. This API action provides\n networking information, EC2 instance type, compute node group status, and scheduler (such\n as Slurm) configuration.
", + "smithy.api#documentation": "Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.
", "smithy.api#readonly": {}, "smithy.api#tags": [ "ComputeNodeGroup" @@ -2307,7 +2386,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed information about a queue. The information includes the compute node\n groups that the queue uses to schedule jobs.
", + "smithy.api#documentation": "Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
", "smithy.api#readonly": {}, "smithy.api#tags": [ "Queue" @@ -2371,7 +2450,7 @@ "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.
\n Example: t2.xlarge\n
The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.
Example: t2.xlarge
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call.\n You can use nextToken to obtain further pages of results. The default \n is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses \n the default.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.
The value of nextToken is a unique pagination token\n for each page of results returned. If nextToken is returned, there are more\n results available. Make the call again using the returned token to retrieve the next page. \n Keep all other arguments unchanged. Each pagination token expires after 24 hours. \n Using an expired pagination token returns an HTTP 400 InvalidToken \n error.
The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.
1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
" + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
" } } }, @@ -2811,13 +2890,13 @@ "subnetIds": { "target": "com.amazonaws.pcs#SubnetIdList", "traits": { - "smithy.api#documentation": "The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to\n enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must\n have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS\n Local Zone.
\n Example: subnet-abcd1234\n
The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone.
Example: subnet-abcd1234
The list of security group IDs associated \n with the Elastic Network Interface (ENI) created in subnets.
\nThe following rules are required:
\nInbound rule 1
\nProtocol: All
\nPorts: All
\nSource: Self
\nOutbound rule 1
\nProtocol: All
\nPorts: All
\nDestination: 0.0.0.0/0 (IPv4)
\nOutbound rule 2
\nProtocol: All
\nPorts: All
\nDestination: Self
\nThe list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
The following rules are required:
Inbound rule 1
Protocol: All
Ports: All
Source: Self
Outbound rule 1
Protocol: All
Ports: All
Destination: 0.0.0.0/0 (IPv4)
Outbound rule 2
Protocol: All
Ports: All
Destination: Self
The list of subnet IDs where Amazon Web Services PCS creates an \n Elastic Network Interface (ENI) to enable communication between managed controllers \n and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
\nAmazon Web Services PCS currently supports only 1 subnet in this list.
\nThe list of subnet IDs where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.
Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.
Amazon Web Services PCS currently supports only 1 subnet in this list.
The provisioning status of the queue.
\nThe provisioning status doesn't indicate the overall health of the queue.
\nThe provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
The list of compute node group configurations associated with the queue. Queues \n assign jobs to associated compute node groups.
", + "smithy.api#documentation": "The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
", "smithy.api#required": {} } }, @@ -3094,7 +3173,7 @@ "status": { "target": "com.amazonaws.pcs#QueueStatus", "traits": { - "smithy.api#documentation": "The provisioning status of the queue.
\nThe provisioning status doesn't indicate the overall health of the queue.
\nThe provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
This API action isn't intended for you to use.
\nAmazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" + "smithy.api#documentation": "This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" } }, "com.amazonaws.pcs#RegisterComputeNodeGroupInstanceRequest": { @@ -3158,7 +3237,7 @@ "sharedSecret": { "target": "com.amazonaws.pcs#SharedSecret", "traits": { - "smithy.api#documentation": "For the Slurm scheduler, this is the shared Munge key the scheduler uses to\n authenticate compute node group instances.
", + "smithy.api#documentation": "For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.
", "smithy.api#required": {} } }, @@ -3201,20 +3280,20 @@ "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The unique identifier of the resource that was not found.\n
", + "smithy.api#documentation": "The unique identifier of the resource that was not found.
", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The type or category of the resource that was not found.\n
", + "smithy.api#documentation": "The type or category of the resource that was not found.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The requested resource can't be found. The cluster, node group, or queue you're\n attempting to get, update, list, or delete doesn't exist.
\n\n Examples\n
", + "smithy.api#documentation": "The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.
Examples
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3310,7 +3389,7 @@ "version": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.\n For more information, see Slurm versions in\n Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
\nValid Values: 23.11 | 24.05\n
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.\n For more information, see Slurm versions in\n Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
\nValid Values: 23.11 | 24.05\n
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
\n The service code associated with the quota that was exceeded.\n
", + "smithy.api#documentation": "The service code associated with the quota that was exceeded.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The unique identifier of the resource that caused the quota to be exceeded.\n
" + "smithy.api#documentation": "The unique identifier of the resource that caused the quota to be exceeded.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The type or category of the resource that caused the quota to be exceeded.\n
" + "smithy.api#documentation": "The type or category of the resource that caused the quota to be exceeded.
" } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The quota code of the service quota that was exceeded.\n
" + "smithy.api#documentation": "The quota code of the service quota that was exceeded.
" } } }, "traits": { - "smithy.api#documentation": "You exceeded your service quota. Service quotas, also referred to as limits, are the\n maximum number of service resources or operations for your Amazon Web Services account. To learn how to\n increase your service quota, see Requesting a quota\n increase in the Service Quotas User Guide\n
\n\n Examples\n
\nThe max number of clusters or queues has been reached for the account.
\nThe max number of compute node groups has been reached for the associated\n cluster.
\nThe total of maxInstances across all compute node groups has been\n reached for associated cluster.
You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. To learn how to increase your service quota, see Requesting a quota increase in the Service Quotas User Guide
Examples
The max number of clusters or queues has been reached for the account.
The max number of compute node groups has been reached for the associated cluster.
The total of maxInstances across all compute node groups has been reached for associated cluster.
Amazon Web Services PCS supports configuration of the following Slurm parameters:
\nFor clusters\n
\n\n \n Prolog\n \n
\n \n Epilog\n \n
For compute node groups\n
\n\n \n Weight\n \n
\n \n RealMemory\n \n
Amazon Web Services PCS supports configuration of the following Slurm parameters:
For clusters
For compute node groups
The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. \n Amazon Web Services PCS supports lowest price, \n capacity optimized, and \n price capacity optimized. \n For more information, see Use \n allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand\n capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option,\n it defaults to price capacity optimized.
" + "smithy.api#documentation": "The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.
" } } }, "traits": { - "smithy.api#documentation": "Additional configuration when you specify SPOT as the\n purchaseOption for the CreateComputeNodeGroup API action.
Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag\n value. The tag key and tag value are case-sensitive strings. The tag value can be an empty\n (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify\n an existing tag key and a new tag value.
", + "smithy.api#documentation": "Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
", "smithy.api#idempotent": {} } }, @@ -3604,7 +3683,7 @@ "tags": { "target": "com.amazonaws.pcs#RequestTagMap", "traits": { - "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a\n tag key and tag value. The tag value is optional and can be an empty\n string.
", + "smithy.api#documentation": "1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
", "smithy.api#required": {} } } @@ -3656,7 +3735,7 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The number of seconds to wait before retrying the request.\n
", + "smithy.api#documentation": "The number of seconds to wait before retrying the request.
", "smithy.api#httpHeader": "Retry-After" } } @@ -3686,7 +3765,7 @@ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the\n Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
", + "smithy.api#documentation": "Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
", "smithy.api#idempotent": {} } }, @@ -3705,7 +3784,7 @@ "target": "com.amazonaws.pcs#TagKeys", "traits": { "aws.iam#conditionKeyValue": "aws:TagKeys", - "smithy.api#documentation": "1 or more tag keys to remove from the resource. Specify only tag keys and not tag\n values.
", + "smithy.api#documentation": "1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.
", "smithy.api#required": {} } } @@ -3768,7 +3847,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a compute node group. You can update many of the fields related to your compute\n node group including the configurations for networking, compute nodes, and settings\n specific to your scheduler (such as Slurm).
", + "smithy.api#documentation": "Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "ComputeNodeGroup" @@ -3795,13 +3874,13 @@ "amiId": { "target": "com.amazonaws.pcs#AmiId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.\n If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch\n template.
" + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" } }, "subnetIds": { "target": "com.amazonaws.pcs#StringList", "traits": { - "smithy.api#documentation": "The list of subnet IDs where the compute node group provisions instances.\n The subnets must be in the same VPC as the cluster.
" + "smithy.api#documentation": "The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.
" } }, "customLaunchTemplate": { @@ -3810,7 +3889,7 @@ "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand\n and Spot instances. For more information, see Instance\n purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this\n option, it defaults to On-Demand.
" + "smithy.api#documentation": "Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
" } }, "spotOptions": { @@ -3825,7 +3904,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.
\n Examples\n
\n\n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n
\n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } } @@ -3903,7 +3982,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the compute node group configuration of a queue. Use this API to change the\n compute node groups that the queue can send jobs to.
", + "smithy.api#documentation": "Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.
", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Queue" @@ -3930,13 +4009,13 @@ "computeNodeGroupConfigurations": { "target": "com.amazonaws.pcs#ComputeNodeGroupConfigurationList", "traits": { - "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues\n assign jobs to associated compute node groups.
" + "smithy.api#documentation": "The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
" } }, "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. Idempotency ensures that an API\n request completes only once. With an idempotent request, if the original \n request completes successfully, the subsequent retries with the same \n client token return the result from the original successful request and \n they have no additional effect. If you don't specify a client token, the \n CLI and SDK automatically generate 1 for you.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
", "smithy.api#idempotencyToken": {} } } @@ -3968,19 +4047,19 @@ "reason": { "target": "com.amazonaws.pcs#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "\n The specific reason or cause of the validation error.\n
", + "smithy.api#documentation": "The specific reason or cause of the validation error.
", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.pcs#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "\n A list of fields or properties that failed validation.\n
" + "smithy.api#documentation": "A list of fields or properties that failed validation.
" } } }, "traits": { - "smithy.api#documentation": "The request isn't valid.
\n\n Examples\n
\nYour request contains malformed JSON or unsupported characters.
\nThe scheduler version isn't supported.
\nThere are networking related errors, such as network validation failure.
\nAMI type is CUSTOM and the launch template doesn't define the AMI ID,\n or the AMI type is AL2 and the launch template defines the AMI.
The request isn't valid.
Examples
Your request contains malformed JSON or unsupported characters.
The scheduler version isn't supported.
There are networking related errors, such as network validation failure.
AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide\n
\nAmazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nYou can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nYou can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this global database cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
\nYou can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this global database cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
\nYou can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for the DB cluster.
\nFor more information, see CreateDBCluster.
" + "smithy.api#documentation": "The lifecycle type for the DB cluster.
\nFor more information, see CreateDBCluster.
" } } }, @@ -9582,7 +9585,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The life cycle type for the DB instance.
\nFor more information, see CreateDBInstance.
" + "smithy.api#documentation": "The lifecycle type for the DB instance.
\nFor more information, see CreateDBInstance.
" } } }, @@ -10096,6 +10099,41 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.rds#DBMajorEngineVersion": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The name of the database engine.
" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The major version number of the database engine.
" + } + }, + "SupportedEngineLifecycles": { + "target": "com.amazonaws.rds#SupportedEngineLifecycleList", + "traits": { + "smithy.api#documentation": "A list of the lifecycles supported by this engine for the\n DescribeDBMajorEngineVersions operation.
This data type is used as a response element in the operation\n DescribeDBMajorEngineVersions.
Describes the properties of specific major versions of DB engines.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBMajorEngineVersions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBMajorEngineVersionsRequest": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#Engine", + "traits": { + "smithy.api#documentation": "The database engine to return major version details for.
\nValid Values:
\n\n aurora-mysql\n
\n aurora-postgresql\n
\n custom-sqlserver-ee\n
\n custom-sqlserver-se\n
\n custom-sqlserver-web\n
\n db2-ae\n
\n db2-se\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
A specific database major engine version to return details for.
\nExample: 8.4\n
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.
The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.
Default: 100
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBMajorEngineVersionsResponse": { + "type": "structure", + "members": { + "DBMajorEngineVersions": { + "target": "com.amazonaws.rds#DBMajorEngineVersionsList", + "traits": { + "smithy.api#documentation": "A list of DBMajorEngineVersion elements.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.
This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:
\n\n CreateDBInstance\n
\n DescribeDBInstances\n
\n DeleteDBInstance\n
For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.
The life cycle type for the global cluster.
\nFor more information, see CreateGlobalCluster.
" + "smithy.api#documentation": "The lifecycle type for the global cluster.
\nFor more information, see CreateGlobalCluster.
" } }, "DatabaseName": { @@ -20829,6 +20946,23 @@ "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" } }, + "com.amazonaws.rds#LifecycleSupportName": { + "type": "enum", + "members": { + "OPEN_SOURCE_RDS_STANDARD_SUPPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-source-rds-standard-support" + } + }, + "OPEN_SOURCE_RDS_EXTENDED_SUPPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-source-rds-extended-support" + } + } + } + }, "com.amazonaws.rds#LimitlessDatabase": { "type": "structure", "members": { @@ -21034,6 +21168,15 @@ "com.amazonaws.rds#LongOptional": { "type": "long" }, + "com.amazonaws.rds#MajorEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.rds#Marker": { "type": "string", "traits": { @@ -27229,7 +27372,7 @@ "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide\n
\nAmazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide\n
\nAmazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide\n
\nAmazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB cluster.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
\nAmazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide\n
\nAmazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide\n
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The life cycle type for this DB instance.
\nBy default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
\nThis setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
\nValid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n
Default: open-source-rds-extended-support\n
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nkms:Encrypt
\nkms:Decrypt
\nkms:GenerateDataKey
\nkms:GenerateDataKeyWithoutPlaintext
\nkms:ReEncryptFrom
\nkms:ReEncryptTo
\nkms:CreateGrant
\nkms:DescribeKey
\nkms:RetireGrant
\nThe ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nkms:CreateGrant
\nkms:DescribeKey
\nThe type of lifecycle support that the engine version is in.
\nThis parameter returns the following values:
\n\n open-source-rds-standard-support - Indicates RDS standard support or Aurora standard support.
\n open-source-rds-extended-support - Indicates Amazon RDS Extended Support.
For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora\n PostgreSQL, this parameter returns both open-source-rds-standard-support\n and open-source-rds-extended-support.
For Amazon RDS for MariaDB, this parameter only returns the value\n open-source-rds-standard-support.
For information about Amazon RDS Extended Support, see Amazon RDS Extended Support\n with Amazon RDS in the Amazon RDS User Guide and Amazon RDS Extended Support with Amazon Aurora in the Amazon\n Aurora User Guide.
", + "smithy.api#required": {} + } + }, + "LifecycleSupportStartDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The start date for the type of support returned by LifecycleSupportName.
The end date for the type of support returned by LifecycleSupportName.
This data type is used as a response element in the operation\n DescribeDBMajorEngineVersions.
You can use the information that this data type returns to plan for upgrades.
\nThis data type only returns information for the open source engines Amazon RDS for\n MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora\n PostgreSQL.
" + } + }, + "com.amazonaws.rds#SupportedEngineLifecycleList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SupportedEngineLifecycle", + "traits": { + "smithy.api#xmlName": "SupportedEngineLifecycle" + } + } + }, "com.amazonaws.rds#SupportedTimezonesList": { "type": "list", "member": { diff --git a/models/s3-control/service/2018-08-20/s3-control-2018-08-20.json b/models/s3-control/service/2018-08-20/s3-control-2018-08-20.json index 3edcd46a..752d20fb 100644 --- a/models/s3-control/service/2018-08-20/s3-control-2018-08-20.json +++ b/models/s3-control/service/2018-08-20/s3-control-2018-08-20.json @@ -819,6 +819,29 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" + }, { "conditions": [ { @@ -834,6 +857,42 @@ "error": "S3Express does not support Dual-stack.", "type": "error" }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -1309,6 +1368,80 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -7846,6 +7979,420 @@ "UseDualStack": false, "UseFIPS": false } + }, + { + "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://my-endpoint.express-control.s3.aws.dev" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided for List", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://my-endpoint.express-control.s3.aws.dev" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Error on Access Point APIs on express bucket for dual stack", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error Access Point APIs on express bucket for dual stack for List", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error on Access Point APIs on express bucket for custom endpoint and dual stack", + "expect": { + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error Access Point APIs on express bucket for custom endpoint and dual stack for List", + "expect": { + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } } ], "version": "1.0" diff --git a/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json b/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json index e8369c39..bd02a463 100644 --- a/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json +++ b/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json @@ -1,33 +1,5 @@ { "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.sagemaker#Accept": { "type": "string", @@ -184,7 +156,7 @@ } }, "traits": { - "smithy.api#documentation": "Lists the properties of an action. An action represents an action\n or activity. Some examples are a workflow step and a model deployment. Generally, an\n action involves at least one input artifact or output artifact.
" + "smithy.api#documentation": "Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.
" } }, "com.amazonaws.sagemaker#ActivationState": { @@ -221,7 +193,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an association between the source and the destination. A\n source can be associated with multiple destinations, and a destination can be associated\n with multiple sources. An association is a lineage tracking entity. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + "smithy.api#documentation": "Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.
" } }, "com.amazonaws.sagemaker#AddAssociationRequest": { @@ -246,7 +218,7 @@ "AssociationType": { "target": "com.amazonaws.sagemaker#AssociationEdgeType", "traits": { - "smithy.api#documentation": "The type of association. The following are suggested uses for each type. Amazon SageMaker\n places no restrictions on their use.
\nContributedTo - The source contributed to the destination or had a part in\n enabling the destination. For example, the training data contributed to the training\n job.
\nAssociatedWith - The source is connected to the destination. For example, an\n approval workflow is associated with a model deployment.
\nDerivedFrom - The destination is a modification of the source. For example, a digest\n output of a channel input for a processing job is derived from the original inputs.
\nProduced - The source generated the destination. For example, a training job\n produced a model artifact.
\nThe type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.
ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.
AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.
DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.
Produced - The source generated the destination. For example, a training job produced a model artifact.
Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Domain or User Profile by calling this API are\n also added to any Apps that the Domain or User Profile launches after you call this\n API, but not to Apps that the Domain or User Profile launched before you called this\n API. To make sure that the tags associated with a Domain or User Profile are also\n added to all Apps that the Domain or User Profile launches, add the tags when you\n first create the Domain or User Profile by specifying them in the Tags\n parameter of CreateDomain\n or CreateUserProfile.
Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.
Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob
Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
", + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
", "smithy.api#required": {} } } @@ -343,7 +315,7 @@ "target": "com.amazonaws.sagemaker#EntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique name to identify the additional inference specification. The name must \n be unique within the list of your additional inference specifications for a \n particular model package.
", + "smithy.api#documentation": "A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
", "smithy.api#required": {} } }, @@ -364,7 +336,7 @@ "SupportedTransformInstanceTypes": { "target": "com.amazonaws.sagemaker#TransformInstanceTypes", "traits": { - "smithy.api#documentation": "A list of the instance types on which a transformation job can be run \n or on which an endpoint can be deployed.
" + "smithy.api#documentation": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
" } }, "SupportedRealtimeInferenceInstanceTypes": { @@ -387,7 +359,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure of additional Inference Specification. Additional Inference Specification \n specifies details about inference jobs that can be run with models based on\n this model package
" + "smithy.api#documentation": "A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
" } }, "com.amazonaws.sagemaker#AdditionalInferenceSpecifications": { @@ -454,7 +426,7 @@ "target": "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The data type of the additional data source that you specify for use in inference or\n training.
", + "smithy.api#documentation": "The data type of the additional data source that you specify for use in inference or training.
", "smithy.api#required": {} } }, @@ -462,14 +434,14 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.
", + "smithy.api#documentation": "The uniform resource identifier (URI) used to identify an additional data source used in inference or training.
", "smithy.api#required": {} } }, "CompressionType": { "target": "com.amazonaws.sagemaker#CompressionType", "traits": { - "smithy.api#documentation": "The type of compression used for an additional data source used in inference or\n training. Specify None if your additional data source is not\n compressed.
The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.
A data source used for training or inference that is in addition to the input dataset\n or model data.
" + "smithy.api#documentation": "A data source used for training or inference that is in addition to the input dataset or model data.
" } }, "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { @@ -675,13 +647,13 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.
You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
For more information, see the note in the AlgorithmName parameter\n description.
The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.
You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.
For more information, see the note in the AlgorithmName parameter description.
The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.
\nYou must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.
Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.
If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.
The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.
You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.
Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.
If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.
A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
" + "smithy.api#documentation": "A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
" } }, "EnableSageMakerMetricsTimeSeries": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:
You use one of the SageMaker built-in algorithms
\nYou use one of the following Prebuilt SageMaker Docker Images:
\nTensorflow (version >= 1.15)
\nMXNet (version >= 1.6)
\nPyTorch (version >= 1.3)
\nYou specify at least one MetricDefinition\n
\nTo generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:
You use one of the SageMaker built-in algorithms
You use one of the following Prebuilt SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
The entrypoint script\n for a Docker container used to run a training job. This script takes\n precedence over the default train processing instructions. See How Amazon SageMaker\n Runs Your Training Image for more information.
" + "smithy.api#documentation": "The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.
" } }, "ContainerArguments": { "target": "com.amazonaws.sagemaker#TrainingContainerArguments", "traits": { - "smithy.api#documentation": "The arguments for a container used to run a training job. See How Amazon SageMaker\n Runs Your Training Image for additional information.
" + "smithy.api#documentation": "The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.
" } }, "TrainingImageConfig": { "target": "com.amazonaws.sagemaker#TrainingImageConfig", "traits": { - "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" + "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training job.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the training algorithm to use in a CreateTrainingJob request.
\nSageMaker uses its own SageMaker account credentials to pull and access built-in algorithms\n so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a result, built-in algorithms have standard,\n unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use\n custom algorithms if you require specific access controls.
\nFor more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
" + "smithy.api#documentation": "Specifies the training algorithm to use in a CreateTrainingJob request.
SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a result, built-in algorithms have standard, unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use custom algorithms if you require specific access controls.
For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
" } }, "com.amazonaws.sagemaker#AlgorithmStatus": { @@ -876,7 +848,7 @@ "target": "com.amazonaws.sagemaker#EntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the profile for the algorithm. The name must have 1 to 63 characters.\n Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } }, @@ -884,19 +856,19 @@ "target": "com.amazonaws.sagemaker#TrainingJobDefinition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobDefinition object that describes the training job that\n SageMaker runs to validate your algorithm.
The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job that\n SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.
Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.
\nThe data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.
The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { @@ -926,13 +898,13 @@ "target": "com.amazonaws.sagemaker#AlgorithmValidationProfiles", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that SageMaker runs to validate your algorithm.
An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.
Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" + "smithy.api#documentation": "Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.
" } }, "com.amazonaws.sagemaker#AmazonQSettings": { @@ -962,7 +934,7 @@ "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
\nFor built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n
\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n
\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n
\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n
\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n
\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n
\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n
\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n
\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.
\n\n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n
The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass
Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass
Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition
Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass
Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection
Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking
3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection
3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation
Use the following ARNs for Label Verification and Adjustment Jobs
Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .
Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation
Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation
Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox
Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox
Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection
Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking
3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection
3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation
The configuration for the file system and the runtime, \n such as the environment variables and entry point.
" + "smithy.api#documentation": "The configuration for the file system and the runtime, such as the environment variables and entry point.
" } } }, @@ -2121,7 +2093,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.
" + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
" } }, "com.amazonaws.sagemaker#AppList": { @@ -2499,7 +2471,7 @@ } }, "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an artifact. An artifact represents a URI\n addressable object or data. Some examples are a dataset and a model.
" + "smithy.api#documentation": "Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.
" } }, "com.amazonaws.sagemaker#AssemblyType": { @@ -2536,7 +2508,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates a trial component with a trial. A trial component can be associated with\n multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
" + "smithy.api#documentation": "Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
" } }, "com.amazonaws.sagemaker#AssociateTrialComponentRequest": { @@ -2690,7 +2662,7 @@ } }, "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.
" + "smithy.api#documentation": "Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.
" } }, "com.amazonaws.sagemaker#AssumableRoleArns": { @@ -2711,12 +2683,12 @@ "MaxConcurrentInvocationsPerInstance": { "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", "traits": { - "smithy.api#documentation": "The maximum number of concurrent requests sent by the SageMaker client to the model\n container. If no value is provided, SageMaker chooses an optimal value.
" + "smithy.api#documentation": "The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.
" } } }, "traits": { - "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" + "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
" } }, "com.amazonaws.sagemaker#AsyncInferenceConfig": { @@ -2725,7 +2697,7 @@ "ClientConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", "traits": { - "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model\n container during asynchronous inference.
" + "smithy.api#documentation": "Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
" } }, "OutputConfig": { @@ -2747,24 +2719,24 @@ "SuccessTopic": { "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference completes successfully. If no\n topic is provided, no notification is sent on success.
" + "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.
" } }, "ErrorTopic": { "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference fails. If no topic is provided,\n no notification is sent on failure.
" + "smithy.api#documentation": "Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.
" } }, "IncludeInferenceResponseIn": { "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList", "traits": { - "smithy.api#documentation": "The Amazon SNS topics where you want the inference response to be included.
\nThe inference response is included only if the response size is less than or equal\n to 128 KB.
\nThe Amazon SNS topics where you want the inference response to be included.
The inference response is included only if the response size is less than or equal to 128 KB.
Specifies the configuration for notifications of inference results for asynchronous\n inference.
" + "smithy.api#documentation": "Specifies the configuration for notifications of inference results for asynchronous inference.
" } }, "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { @@ -2773,7 +2745,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.
\n " + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
" } }, "S3OutputPath": { @@ -2785,7 +2757,7 @@ "NotificationConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", "traits": { - "smithy.api#documentation": "Specifies the configuration for notifications of inference results for asynchronous\n inference.
" + "smithy.api#documentation": "Specifies the configuration for notifications of inference results for asynchronous inference.
" } }, "S3FailurePath": { @@ -2888,7 +2860,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker\n uses to encrypt data generated from an Athena query execution.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
" } }, "OutputFormat": { @@ -3171,13 +3143,13 @@ "target": "com.amazonaws.sagemaker#AutoMLAlgorithms", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
\n\n For the tabular problem type\n TabularJobConfig:\n
Selected algorithms must belong to the list corresponding to the training mode\n set in AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.
In ENSEMBLING mode:
\"catboost\"
\n\"extra-trees\"
\n\"fastai\"
\n\"lightgbm\"
\n\"linear-learner\"
\n\"nn-torch\"
\n\"randomforest\"
\n\"xgboost\"
\nIn HYPERPARAMETER_TUNING mode:
\"linear-learner\"
\n\"mlp\"
\n\"xgboost\"
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig:\n
Choose your algorithms from this list.
\n\"cnn-qr\"
\n\"deepar\"
\n\"prophet\"
\n\"arima\"
\n\"npts\"
\n\"ets\"
\nThe selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.
For the tabular problem type TabularJobConfig:
Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.
In ENSEMBLING mode:
\"catboost\"
\"extra-trees\"
\"fastai\"
\"lightgbm\"
\"linear-learner\"
\"nn-torch\"
\"randomforest\"
\"xgboost\"
In HYPERPARAMETER_TUNING mode:
\"linear-learner\"
\"mlp\"
\"xgboost\"
For the time-series forecasting problem type TimeSeriesForecastingJobConfig:
Choose your algorithms from this list.
\"cnn-qr\"
\"deepar\"
\"prophet\"
\"arima\"
\"npts\"
\"ets\"
The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.
" + "smithy.api#documentation": "The selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.
" } }, "com.amazonaws.sagemaker#AutoMLAlgorithms": { @@ -3285,12 +3257,12 @@ "InferenceContainerDefinitions": { "target": "com.amazonaws.sagemaker#AutoMLInferenceContainerDefinitions", "traits": { - "smithy.api#documentation": "The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the AutoML jobs V2 (for example,\n for jobs created by calling CreateAutoMLJobV2) related to image or text\n classification problem types only.
The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.
Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.
" + "smithy.api#documentation": "Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.
" } }, "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig": { @@ -3299,13 +3271,13 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
These column keys may not include the target column.
In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
Stores the configuration information for the selection of algorithms trained on tabular\n data.
\nThe list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .
\n AlgorithmsConfig should not be set if the training mode is set on\n AUTO.
When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" + "smithy.api#documentation": "Stores the configuration information for the selection of algorithms trained on tabular data.
The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .
AlgorithmsConfig should not be set if the training mode is set on AUTO.
When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.
When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.
For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.
For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" } } }, @@ -3363,38 +3335,38 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#CompressionType", "traits": { - "smithy.api#documentation": "You can use Gzip or None. The default value is\n None.
You can use Gzip or None. The default value is None.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", + "smithy.api#documentation": "The name of the target variable in supervised learning, usually represented by 'y'.
", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemaker#ContentType", "traits": { - "smithy.api#documentation": "The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.
The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
The channel type (optional) is an enum string. The default value is\n training. Channels for training and validation must share the same\n ContentType and TargetAttributeName. For information on\n specifying training and validation channel types, see How to specify training and validation datasets.
The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.
If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" + "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.
Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.
Support for sample weights is available in Ensembling mode only.
" } } }, "traits": { - "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. The validation\n dataset size is limited to less than 2 GB. The training dataset size must be less than 100\n GB. For more information, see Channel.
\nA validation dataset must contain the same headers as the training dataset.
\nA channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.
A validation dataset must contain the same headers as the training dataset.
The configuration for using EMR Serverless\n to run the AutoML job V2.
\nTo allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless\n when additional compute resources are needed to process large datasets, you need to provide\n an EmrServerlessComputeConfig object, which includes an\n ExecutionRoleARN attribute, to the AutoMLComputeConfig of the\n AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle\n datasets that would otherwise exceed the initially provisioned resources, without any\n manual intervention from you.
\nEMR Serverless is available for the tabular and time series problem types. We\n recommend setting up this option for tabular datasets larger than 5 GB and time series\n datasets larger than 30 GB.
" + "smithy.api#documentation": "The configuration for using EMR Serverless to run the AutoML job V2.
To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless when additional compute resources are needed to process large datasets, you need to provide an EmrServerlessComputeConfig object, which includes an ExecutionRoleARN attribute, to the AutoMLComputeConfig of the AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle datasets that would otherwise exceed the initially provisioned resources, without any manual intervention from you.
EMR Serverless is available for the tabular and time series problem types. We recommend setting up this option for tabular datasets larger than 5 GB and time series datasets larger than 30 GB.
" } } }, "traits": { - "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for an AutoML job V2.
" + "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for an AutoML job V2.
" } }, "com.amazonaws.sagemaker#AutoMLContainerDefinition": { @@ -3435,7 +3407,7 @@ "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more\n information, see \n ContainerDefinition.
", + "smithy.api#documentation": "The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.
", "smithy.api#required": {} } }, @@ -3443,19 +3415,19 @@ "target": "com.amazonaws.sagemaker#Url", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the model artifacts. For more information, see \n ContainerDefinition.
", + "smithy.api#documentation": "The location of the model artifacts. For more information, see ContainerDefinition.
", "smithy.api#required": {} } }, "Environment": { "target": "com.amazonaws.sagemaker#EnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the container. For more information, see \n ContainerDefinition.
" + "smithy.api#documentation": "The environment variables to set in the container. For more information, see ContainerDefinition.
" } } }, "traits": { - "smithy.api#documentation": "A list of container definitions that describe the different containers that make up an\n AutoML candidate. For more information, see \n ContainerDefinition.
" + "smithy.api#documentation": "A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.
" } }, "com.amazonaws.sagemaker#AutoMLContainerDefinitions": { @@ -3492,12 +3464,12 @@ "ValidationFraction": { "target": "com.amazonaws.sagemaker#ValidationFraction", "traits": { - "smithy.api#documentation": "The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values must be greater\n than 0 and less than 1. We recommend setting this value to be less than 0.5.
" + "smithy.api#documentation": "The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.
" } } }, "traits": { - "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
This structure specifies how to split the data into train and validation datasets.
The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.
Processing unit for an inference container. Currently Autopilot only supports\n CPU or GPU.
Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.
The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the V2 API only (for example,\n for jobs created by calling CreateAutoMLJobV2).
The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).
The type of channel. Defines whether the data are used for training or validation. The\n default value is training. Channels for training and\n validation must share the same ContentType\n
The type of channel defaults to training for the time-series forecasting\n problem type.
The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType
The type of channel defaults to training for the time-series forecasting problem type.
The content type of the data from the input source. The following are the allowed\n content types for different problems:
\nFor tabular problem types: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For image classification: image/png, image/jpeg, or\n image/*. The default value is image/*.
For text classification: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For time-series forecasting: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For text generation (LLMs fine-tuning): text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
The content type of the data from the input source. The following are the allowed content types for different problems:
For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
For image classification: image/png, image/jpeg, or image/*. The default value is image/*.
For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
The allowed compression types depend on the input format and problem type. We allow the\n compression type Gzip for S3Prefix inputs on tabular data only.\n For all other inputs, the compression type should be None. If no compression\n type is provided, we default to None.
The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.
A channel is a named input source that training algorithms can consume. This channel is\n used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
" + "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
" } }, "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria": { @@ -3611,24 +3583,24 @@ "MaxCandidates": { "target": "com.amazonaws.sagemaker#MaxCandidates", "traits": { - "smithy.api#documentation": "The maximum number of times a training job is allowed to run.
\nFor text and image classification, time-series forecasting, as well as text generation\n (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the\n maximum value is 750.
" + "smithy.api#documentation": "The maximum number of times a training job is allowed to run.
For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.
" } }, "MaxRuntimePerTrainingJobInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.
\nFor job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.
For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours\n (259200 seconds).
" + "smithy.api#documentation": "The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.
For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.
For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).
" } }, "MaxAutoMLJobRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds", "traits": { - "smithy.api#documentation": "The maximum runtime, in seconds, an AutoML job has to complete.
\nIf an AutoML job exceeds the maximum runtime, the job is stopped automatically and its\n processing is ended gracefully. The AutoML job identifies the best model whose training was\n completed and marks it as the best-performing model. Any unfinished steps of the job, such\n as automatic one-click Autopilot model deployment, are not completed.
" + "smithy.api#documentation": "The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
" } } }, "traits": { - "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to generate.
" } }, "com.amazonaws.sagemaker#AutoMLJobConfig": { @@ -3637,7 +3609,7 @@ "CompletionCriteria": { "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", "traits": { - "smithy.api#documentation": "How long an AutoML job is allowed to run, or how many candidates a job is allowed to\n generate.
" + "smithy.api#documentation": "How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.
" } }, "SecurityConfig": { @@ -3655,13 +3627,13 @@ "DataSplitConfig": { "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", "traits": { - "smithy.api#documentation": "The configuration for splitting the input training dataset.
\nType: AutoMLDataSplitConfig
" + "smithy.api#documentation": "The configuration for splitting the input training dataset.
Type: AutoMLDataSplitConfig
" } }, "Mode": { "target": "com.amazonaws.sagemaker#AutoMLMode", "traits": { - "smithy.api#documentation": "The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nThe list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.
\nFor tabular problem types:
\nList of available metrics:
\n Regression: MAE, MSE, R2,\n RMSE\n
Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n
Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n
For a description of each metric, see Autopilot metrics for classification and regression.
\nDefault objective metrics:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
\nList of available metrics: Accuracy\n
For a description of each metric, see Autopilot metrics for text and image classification.
\nDefault objective metrics: Accuracy\n
For time-series forecasting problem types:
\nList of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n
For a description of each metric, see Autopilot metrics for\n time-series forecasting.
\nDefault objective metrics: AverageWeightedQuantileLoss\n
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model's parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.
The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.
For tabular problem types:
List of available metrics:
Regression: MAE, MSE, R2, RMSE
Binary classification: Accuracy, AUC, BalancedAccuracy, F1, Precision, Recall
Multiclass classification: Accuracy, BalancedAccuracy, F1macro, PrecisionMacro, RecallMacro
For a description of each metric, see Autopilot metrics for classification and regression.
Default objective metrics:
Regression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types:
List of available metrics: Accuracy
For a description of each metric, see Autopilot metrics for text and image classification.
Default objective metrics: Accuracy
For time-series forecasting problem types:
List of available metrics: RMSE, wQL, Average wQL, MASE, MAPE, WAPE
For a description of each metric, see Autopilot metrics for time-series forecasting.
Default objective metrics: AverageWeightedQuantileLoss
For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.
Settings used to configure an AutoML job V2 for the image classification problem\n type.
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the image classification problem type.
" } }, "TextClassificationJobConfig": { "target": "com.amazonaws.sagemaker#TextClassificationJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text classification problem\n type.
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text classification problem type.
" } }, "TimeSeriesForecastingJobConfig": { "target": "com.amazonaws.sagemaker#TimeSeriesForecastingJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the time-series forecasting problem\n type.
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the time-series forecasting problem type.
" } }, "TabularJobConfig": { "target": "com.amazonaws.sagemaker#TabularJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the tabular problem type (regression,\n classification).
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).
" } }, "TextGenerationJobConfig": { "target": "com.amazonaws.sagemaker#TextGenerationJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning)\n problem type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nSettings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.
The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.
A collection of settings specific to the problem type used to configure an AutoML job V2.\n There must be one and only one config of the following type.
" + "smithy.api#documentation": "A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.
" } }, "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName": { @@ -4476,7 +4448,7 @@ "target": "com.amazonaws.sagemaker#AutoMLS3DataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The data type.
\nIf you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker AI uses all objects that match the specified key name prefix\n for model training.
The S3Prefix should have the following format:
\n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n
If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.
A ManifestFile should have the format shown below:
\n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n
\n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n
\n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n
If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).
Here is a minimal, single-record example of an\n AugmentedManifestFile:
\n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n
\n \"label-metadata\": {\"class-name\": \"cat\" }
For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.
The data type.
If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker AI uses all objects that match the specified key name prefix for model training.
The S3Prefix should have the following format:
s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.
A ManifestFile should have the format shown below:
[ {\"prefix\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"},
\"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",
\"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",
... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]
If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).
Here is a minimal, single-record example of an AugmentedManifestFile:
{\"source-ref\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",
\"label-metadata\": {\"class-name\": \"cat\" }
For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.
The URL to the Amazon S3 data source. The Uri refers to the Amazon S3\n prefix or ManifestFile depending on the data type.
", + "smithy.api#documentation": "The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.
", "smithy.api#required": {} } } @@ -4626,7 +4598,7 @@ } }, "traits": { - "smithy.api#documentation": "The name and an example value of the hyperparameter that you want to use in Autotune.\n If Automatic model tuning (AMT) determines that your hyperparameter is eligible for\n Autotune, an optimal hyperparameter range is selected for you.
" + "smithy.api#documentation": "The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.
" } }, "com.amazonaws.sagemaker#AutoParameters": { @@ -4659,12 +4631,12 @@ "Alarms": { "target": "com.amazonaws.sagemaker#AlarmList", "traits": { - "smithy.api#documentation": "List of CloudWatch alarms in your account that are configured to monitor metrics on an\n endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the\n deployment.
" + "smithy.api#documentation": "List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.
" } } }, "traits": { - "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" + "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and recovery.
" } }, "com.amazonaws.sagemaker#Autotune": { @@ -4680,7 +4652,7 @@ } }, "traits": { - "smithy.api#documentation": "A flag to indicate if you want to use Autotune to automatically find optimal values\n for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nA flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes\n accepts a cluster name and a list of node IDs.
To safeguard your work, back up your data to Amazon S3 or an FSx for\n Lustre file system before invoking the API on a worker node group. This will help\n prevent any potential data loss from the instance root volume. For more\n information about backup, see Use the backup script provided by SageMaker HyperPod.
\nIf you want to invoke this API on an existing cluster, you'll first need to\n patch the cluster by running the UpdateClusterSoftware API. For more information about patching a\n cluster, see Update the SageMaker HyperPod platform software of a cluster.
\nDeletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.
To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.
The error code associated with the error encountered when deleting a node.
\nThe code provides information about the specific issue encountered, such as the node not\n being found, the node's status being invalid for deletion, or the node ID being in use by\n another process.
", + "smithy.api#documentation": "The error code associated with the error encountered when deleting a node.
The code provides information about the specific issue encountered, such as the node not being found, the node's status being invalid for deletion, or the node ID being in use by another process.
", "smithy.api#required": {} } }, @@ -4874,7 +4846,7 @@ "target": "com.amazonaws.sagemaker#ClusterNodeIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of node IDs to be deleted from the specified cluster.
\nFor SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove\n instances that are configured as Slurm controller nodes.
\nIf you need to delete more than 99 instances, contact Support for assistance.
\nA list of node IDs to be deleted from the specified cluster.
For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.
If you need to delete more than 99 instances, contact Support for assistance.
A map of the resource and BatchDescribeModelPackageError objects reporting the error\n associated with describing the model package.
" + "smithy.api#documentation": "A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.
" } } }, @@ -5096,13 +5068,13 @@ "S3InputMode": { "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", "traits": { - "smithy.api#documentation": "Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defaults to FullyReplicated\n
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" } }, "EndTimeOffset": { "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", "traits": { - "smithy.api#documentation": "If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + "smithy.api#documentation": "If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" } }, "ExcludeFeaturesAttribute": { @@ -5158,12 +5130,12 @@ "MaxNumberOfTrainingJobsNotImproving": { "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobsNotImproving", "traits": { - "smithy.api#documentation": "The number of training jobs that have failed to improve model performance by 1% or\n greater over prior training jobs as evaluated against an objective function.
" + "smithy.api#documentation": "The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.
" } } }, "traits": { - "smithy.api#documentation": "A structure that keeps track of which training jobs launched by your hyperparameter\n tuning job are not improving model performance as evaluated against an objective\n function.
" + "smithy.api#documentation": "A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.
" } }, "com.amazonaws.sagemaker#Bias": { @@ -5216,25 +5188,25 @@ "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the traffic routing strategy to shift traffic from the old fleet to the new\n fleet during an endpoint deployment.
", + "smithy.api#documentation": "Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
", "smithy.api#required": {} } }, "TerminationWaitInSeconds": { "target": "com.amazonaws.sagemaker#TerminationWaitInSeconds", "traits": { - "smithy.api#documentation": "Additional waiting time in seconds after the completion of an endpoint deployment\n before terminating the old endpoint fleet. Default is 0.
" + "smithy.api#documentation": "Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
" } }, "MaximumExecutionTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", "traits": { - "smithy.api#documentation": "Maximum execution timeout for the deployment. Note that the timeout value should be\n larger than the total waiting time specified in TerminationWaitInSeconds\n and WaitIntervalInSeconds.
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" + "smithy.api#documentation": "Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
" } }, "com.amazonaws.sagemaker#Boolean": { @@ -5343,20 +5315,20 @@ "target": "com.amazonaws.sagemaker#ExplainabilityLocation", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 prefix to the explainability artifacts generated for the AutoML\n candidate.
", + "smithy.api#documentation": "The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.
", "smithy.api#required": {} } }, "ModelInsights": { "target": "com.amazonaws.sagemaker#ModelInsightsLocation", "traits": { - "smithy.api#documentation": "The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.
" + "smithy.api#documentation": "The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.
" } }, "BacktestResults": { "target": "com.amazonaws.sagemaker#BacktestResultsLocation", "traits": { - "smithy.api#documentation": "The Amazon S3 prefix to the accuracy metrics and the inference results observed\n over the testing window. Available only for the time-series forecasting problem\n type.
" + "smithy.api#documentation": "The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.
" } } }, @@ -5378,12 +5350,12 @@ "AlgorithmsConfig": { "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", "traits": { - "smithy.api#documentation": "Your Autopilot job trains a default set of algorithms on your dataset. For tabular and\n time-series data, you can customize the algorithm list by selecting a subset of algorithms\n for your problem type.
\n\n AlgorithmsConfig stores the customized selection of algorithms to train on\n your data.
\n For the tabular problem type\n TabularJobConfig, the list of available algorithms to\n choose from depends on the training mode set in \n AutoMLJobConfig.Mode\n .
\n AlgorithmsConfig should not be set when the training mode\n AutoMLJobConfig.Mode is set to AUTO.
When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.
For the list of all algorithms per training mode, see \n AlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.
\n\n For the time-series forecasting problem type\n TimeSeriesForecastingJobConfig, choose your algorithms\n from the list provided in \n AlgorithmConfig.
For more information on each algorithm, see the Algorithms\n support for time-series forecasting section in the Autopilot developer\n guide.
\nWhen AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.
Your Autopilot job trains a default set of algorithms on your dataset. For tabular and time-series data, you can customize the algorithm list by selecting a subset of algorithms for your problem type.
AlgorithmsConfig stores the customized selection of algorithms to train on your data.
For the tabular problem type TabularJobConfig, the list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .
AlgorithmsConfig should not be set when the training mode AutoMLJobConfig.Mode is set to AUTO.
When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.
When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.
For the list of all algorithms per training mode, see AlgorithmConfig.
For more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.
For the time-series forecasting problem type TimeSeriesForecastingJobConfig, choose your algorithms from the list provided in AlgorithmConfig.
For more information on each algorithm, see the Algorithms support for time-series forecasting section in the Autopilot developer guide.
When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.
When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.
Stores the configuration information for how model candidates are generated using an\n AutoML job V2.
" + "smithy.api#documentation": "Stores the configuration information for how model candidates are generated using an AutoML job V2.
" } }, "com.amazonaws.sagemaker#CandidateName": { @@ -5584,7 +5556,7 @@ "target": "com.amazonaws.sagemaker#CapacitySizeType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the endpoint capacity type.
\n\n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.
\n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.
Specifies the endpoint capacity type.
INSTANCE_COUNT: The endpoint activates based on the number of instances.
CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
Defines the capacity size, either as a number of instances or a capacity\n percentage.
", + "smithy.api#documentation": "Defines the capacity size, either as a number of instances or a capacity percentage.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.
Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.
For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
The configuration of the size measurements of the AMI update. Using this\n configuration, you can specify whether SageMaker should update your instance group\n by an amount or percentage of instances.
" + "smithy.api#documentation": "The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.
" } }, "com.amazonaws.sagemaker#CapacitySizeType": { @@ -5665,18 +5637,18 @@ "CsvContentTypes": { "target": "com.amazonaws.sagemaker#CsvContentTypes", "traits": { - "smithy.api#documentation": "The list of all content type headers that Amazon SageMaker AI will treat as CSV and\n capture accordingly.
" + "smithy.api#documentation": "The list of all content type headers that Amazon SageMaker AI will treat as CSV and capture accordingly.
" } }, "JsonContentTypes": { "target": "com.amazonaws.sagemaker#JsonContentTypes", "traits": { - "smithy.api#documentation": "The list of all content type headers that SageMaker AI will treat as JSON and\n capture accordingly.
" + "smithy.api#documentation": "The list of all content type headers that SageMaker AI will treat as JSON and capture accordingly.
" } } }, "traits": { - "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n Amazon SageMaker AI will by default base64 encode when capturing the data.
" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI will by default base64 encode when capturing the data.
" } }, "com.amazonaws.sagemaker#CaptureMode": { @@ -5796,7 +5768,7 @@ "target": "com.amazonaws.sagemaker#ParameterValues", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of the categories\n for\n the hyperparameter.
", + "smithy.api#documentation": "A list of the categories for the hyperparameter.
", "smithy.api#required": {} } } @@ -5897,25 +5869,25 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#CompressionType", "traits": { - "smithy.api#documentation": "If training data is compressed, the compression type. The default value is\n None. CompressionType is used only in Pipe input mode. In\n File mode, leave this field unset or set it to None.
If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.
\nIn File mode, leave this field unset or set it to None.
" + "smithy.api#documentation": "Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
" } }, "InputMode": { "target": "com.amazonaws.sagemaker#TrainingInputMode", "traits": { - "smithy.api#documentation": "(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a\n different input mode from the training job's general setting. To download the data from\n Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a\n Docker volume, use File input mode. To stream data directly from Amazon S3 to\n the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
The allowed input mode, either FILE or PIPE.
\nIn FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon\n Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This\n is the most commonly used input mode.
\nIn PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm\n without using the EBS volume.
", + "smithy.api#documentation": "The allowed input mode, either FILE or PIPE.
In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.
In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
", "smithy.api#required": {} } } @@ -6002,19 +5974,19 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the S3 path where you want SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.
Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
(Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
Contains information about the output location for managed spot training checkpoint\n data.
" + "smithy.api#documentation": "Contains information about the output location for managed spot training checkpoint data.
" } }, "com.amazonaws.sagemaker#Cidr": { @@ -6069,24 +6041,24 @@ "CheckJobArn": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's\n execution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
" } }, "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped\n or not. If it is set to False, the previous baseline of the configured\n check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step\n properties BaselineUsedForDriftCheckConstraints and\n BaselineUsedForDriftCheckStatistics. If it is set to\n False, the previous baseline of the configured check type must also be\n available. These can be accessed through the\n BaselineUsedForDriftCheckConstraints property.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, see\n the topic on ClarifyCheck step in the Amazon SageMaker Developer\n Guide.
" + "smithy.api#documentation": "The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#ClarifyContentTemplate": { @@ -6115,7 +6087,7 @@ "EnableExplanations": { "target": "com.amazonaws.sagemaker#ClarifyEnableExplanations", "traits": { - "smithy.api#documentation": "A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.
A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.
Provides the JMESPath expression to extract the features from a model container input\n in JSON Lines format. For example, if FeaturesAttribute is the JMESPath\n expression 'myfeatures', it extracts a list of features\n [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.
Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression 'myfeatures', it extracts a list of features [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.
A template string used to format a JSON record into an acceptable model container\n input. For example, a ContentTemplate string\n '{\"myfeatures\":$features}' will format a list of features\n [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'.\n Required only when the model container input is in JSON Lines format.
A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string '{\"myfeatures\":$features}' will format a list of features [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'. Required only when the model container input is in JSON Lines format.
The maximum number of records in a request that the model container can process when\n querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be\n made on, for example, a single line in CSV data. If MaxRecordCount is\n 1, the model container expects one record per request. A value of 2 or\n greater means that the model expects batch requests, which can reduce overhead and speed\n up the inferencing process. If this parameter is not provided, the explainer will tune\n the record count per request according to the model container's capacity at\n runtime.
The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.
The maximum payload size (MB) allowed of a request from the explainer to the model\n container. Defaults to 6 MB.
The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.
A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.
\n\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.
\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].
A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.
Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6', set ProbabilityIndex to 1 to select the probability value 0.6.
Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].
A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.
\n\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].
A zero-based index used to extract a label header or list of label headers from model container output in CSV format.
Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set LabelIndex to 0 to select the label headers ['cat','dog','fish'].
A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.
\n\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.
A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.
Example: If the model container output of a single request is '{\"predicted_label\":1,\"probability\":0.6}', then set ProbabilityAttribute to 'probability'.
A JMESPath expression used to locate the list of label headers in the model container\n output.
\n\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n
A JMESPath expression used to locate the list of label headers in the model container output.
Example: If the model container output of a batch request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}', then set LabelAttribute to 'labels' to extract the list of label headers [\"cat\",\"dog\",\"fish\"]
For multiclass classification problems, the label headers are the names of the\n classes. Otherwise, the label header is the name of the predicted label. These are used\n to help readability for the output of the InvokeEndpoint API. See the\n response section under Invoke the endpoint\n in the Developer Guide for more information. If there are no label headers in the model\n container output, provide them manually using this parameter.
For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.
The names of the features. If provided, these are included in the endpoint response\n payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint\n in the Developer Guide for more information.
The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.
A list of data types of the features (optional). Applicable only to NLP\n explainability. If provided, FeatureTypes must have at least one\n 'text' string (for example, ['text']). If\n FeatureTypes is not provided, the explainer infers the feature types\n based on the baseline data. The feature types are included in the endpoint response\n payload. For additional information see the response section under Invoke the endpoint\n in the Developer Guide for more information.
A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.
The MIME type of the baseline data. Choose from 'text/csv' or\n 'application/jsonlines'. Defaults to 'text/csv'.
The MIME type of the baseline data. Choose from 'text/csv' or 'application/jsonlines'. Defaults to 'text/csv'.
The inline SHAP baseline data in string format. ShapBaseline can have one\n or multiple records to be used as the baseline dataset. The format of the SHAP baseline\n file should be the same format as the training dataset. For example, if the training\n dataset is in CSV format and each record contains four features, and all features are\n numerical, then the format of the baseline data should also share these characteristics.\n For natural language processing (NLP) of text columns, the baseline value should be the\n value used to replace the unit of text specified by the Granularity of the\n TextConfig parameter. The size limit for ShapBasline is 4\n KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB\n of baseline data.
The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is\n stored. The format of the SHAP baseline file should be the same format as the format of\n the training dataset. For example, if the training dataset is in CSV format, and each\n record in the training dataset has four features, and all features are numerical, then\n the baseline file should also have this same format. Each record should contain only the\n features. If you are using a virtual private cloud (VPC), the\n ShapBaselineUri should be accessible to the VPC. For more information\n about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to\n Resources in your Amazon Virtual Private Cloud.
The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.
The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.
\nThe number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.
\n\n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.
The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.
The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.
ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.
The number of samples to be used for analysis by the Kernal SHAP algorithm.
\nThe number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.
\nThe number of samples to be used for analysis by the Kernal SHAP algorithm.
The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.
A Boolean toggle to indicate if you want to use the logit function (true) or log-odds\n units (false) for model predictions. Defaults to false.
" + "smithy.api#documentation": "A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.
" } }, "Seed": { "target": "com.amazonaws.sagemaker#ClarifyShapSeed", "traits": { - "smithy.api#documentation": "The starting value used to initialize the random number generator in the explainer.\n Provide a value for this parameter to obtain a deterministic SHAP result.
" + "smithy.api#documentation": "The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.
" } }, "TextConfig": { "target": "com.amazonaws.sagemaker#ClarifyTextConfig", "traits": { - "smithy.api#documentation": "A parameter that indicates if text features are treated as text and explanations are\n provided for individual units of text. Required for natural language processing (NLP)\n explainability only.
" + "smithy.api#documentation": "A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.
" } } }, @@ -6450,7 +6422,7 @@ "target": "com.amazonaws.sagemaker#ClarifyTextLanguage", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.
\nFor a mix of multiple languages, use code 'xx'.
Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
For a mix of multiple languages, use code 'xx'.
The unit of granularity for the analysis of text features. For example, if the unit is\n 'token', then each token (like a word in English) of the text is\n treated as a feature. SHAP values are computed for each unit/feature.
The unit of granularity for the analysis of text features. For example, if the unit is 'token', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.
A parameter used to configure the SageMaker Clarify explainer to treat text features as text so\n that explanations are provided for individual units of text. Required only for natural\n language processing (NLP) explainability.
" + "smithy.api#documentation": "A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.
" } }, "com.amazonaws.sagemaker#ClarifyTextGranularity": { @@ -6915,13 +6887,13 @@ "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size in gigabytes (GB) of the additional EBS volume to be attached to the instances\n in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each\n instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" + "smithy.api#documentation": "Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" } }, "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { @@ -6948,13 +6920,13 @@ "CurrentCount": { "target": "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod\n cluster.
" + "smithy.api#documentation": "The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
" } }, "TargetCount": { "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { - "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod\n cluster.
" + "smithy.api#documentation": "The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
" } }, "InstanceGroupName": { @@ -6984,43 +6956,43 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "The number you specified to TreadsPerCore in CreateCluster for\n enabling or disabling multithreading. For instance types that support multithreading, you\n can specify 1 for disabling multithreading and 2 for enabling multithreading. For more\n information, see the reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance\n group.
" + "smithy.api#documentation": "The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
" } }, "OnStartDeepHealthChecks": { "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", "traits": { - "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" + "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
" } }, "Status": { "target": "com.amazonaws.sagemaker#InstanceGroupStatus", "traits": { - "smithy.api#documentation": "The current status of the cluster instance group.
\n\n InService: The instance group is active and healthy.
\n Creating: The instance group is being provisioned.
\n Updating: The instance group is being updated.
\n Failed: The instance group has failed to provision or is no longer\n healthy.
\n Degraded: The instance group is degraded, meaning that some instances\n have failed to provision or are no longer healthy.
\n Deleting: The instance group is being deleted.
The current status of the cluster instance group.
InService: The instance group is active and healthy.
Creating: The instance group is being provisioned.
Updating: The instance group is being updated.
Failed: The instance group has failed to provision or is no longer healthy.
Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
Deleting: The instance group is being deleted.
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The current status of the training plan associated with this cluster instance\n group.
" + "smithy.api#documentation": "The current status of the training plan associated with this cluster instance group.
" } }, "OverrideVpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "The customized Amazon VPC configuration at the instance group level that\n overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" } }, "ScheduledUpdateConfig": { @@ -7057,7 +7029,7 @@ "target": "com.amazonaws.sagemaker#ClusterInstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", + "smithy.api#documentation": "Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.
", "smithy.api#required": {} } }, @@ -7096,31 +7068,31 @@ "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "Specifies the value for Threads per core. For instance\n types that support multithreading, you can specify 1 for disabling\n multithreading and 2 for enabling multithreading. For instance types that\n doesn't support multithreading, specify 1. For more information, see the\n reference table of CPU cores and\n threads per CPU core per instance type in the Amazon Elastic Compute Cloud User\n Guide.
Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster\n instance group.
" + "smithy.api#documentation": "Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
" } }, "OnStartDeepHealthChecks": { "target": "com.amazonaws.sagemaker#OnStartDeepHealthChecks", "traits": { - "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster\n instance group is created or updated.
" + "smithy.api#documentation": "A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
" } }, "TrainingPlanArn": { "target": "com.amazonaws.sagemaker#TrainingPlanArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
To configure multi-AZ deployments, customize the Amazon VPC configuration at the\n instance group level. You can specify different subnets and security groups across\n different AZs in the instance group specification to override a SageMaker HyperPod cluster's default\n Amazon VPC configuration. For more information about deploying a cluster in\n multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
\nWhen your Amazon VPC and subnets support IPv6, network communications differ\n based on the cluster orchestration platform:
\nSlurm-orchestrated clusters automatically configure nodes with dual IPv6 and\n IPv4 addresses, allowing immediate IPv6 network communications.
\nIn Amazon EKS-orchestrated clusters, nodes receive dual-stack\n addressing, but pods can only use IPv6 when the Amazon EKS cluster is\n explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
\nAdditional resources for IPv6 configuration:
\nFor information about adding IPv6 support to your VPC, see to IPv6\n Support for VPC.
\nFor information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
\nTo configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
\nTo configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster\n is launched.
" + "smithy.api#documentation": "The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the placement details for the node in the SageMaker HyperPod cluster, including the\n Availability Zone and the unique identifier (ID) of the Availability Zone.
" + "smithy.api#documentation": "Specifies the placement details for the node in the SageMaker HyperPod cluster, including the Availability Zone and the unique identifier (ID) of the Availability Zone.
" } }, "com.amazonaws.sagemaker#ClusterInstanceStatus": { @@ -7247,12 +7219,12 @@ "EbsVolumeConfig": { "target": "com.amazonaws.sagemaker#ClusterEbsVolumeConfig", "traits": { - "smithy.api#documentation": "Defines the configuration for attaching additional Amazon Elastic Block Store (EBS)\n volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is\n attached to each instance within the SageMaker HyperPod cluster instance group and mounted to\n /opt/sagemaker.
Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" + "smithy.api#documentation": "Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" } }, "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { @@ -7945,7 +7917,7 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An Amazon S3 bucket path where your lifecycle scripts are stored.
\nMake sure that the S3 bucket path starts with s3://sagemaker-. The\n IAM role for SageMaker HyperPod has the managed \n AmazonSageMakerClusterInstanceRolePolicy\n attached, which\n allows access to S3 buckets with the specific prefix sagemaker-.
An Amazon S3 bucket path where your lifecycle scripts are stored.
Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.
The file name of the entrypoint script of lifecycle scripts under\n SourceS3Uri. This entrypoint script runs during cluster creation.
The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
The time of when the cluster was last updated.
" + "smithy.api#documentation": "The time when the cluster was last updated.
" } }, "LifeCycleConfig": { @@ -8040,19 +8012,19 @@ "OverrideVpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "The customized Amazon VPC configuration at the instance group level that\n overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" } }, "ThreadsPerCore": { "target": "com.amazonaws.sagemaker#ClusterThreadsPerCore", "traits": { - "smithy.api#documentation": "The number of threads per CPU core you specified under\n CreateCluster.
The number of threads per CPU core you specified under CreateCluster.
The configurations of additional storage specified to the instance group where the\n instance (node) is launched.
" + "smithy.api#documentation": "The configurations of additional storage specified to the instance group where the instance (node) is launched.
" } }, "PrivatePrimaryIp": { @@ -8064,7 +8036,7 @@ "PrivatePrimaryIpv6": { "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIpv6", "traits": { - "smithy.api#documentation": "The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an\n Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled\n in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
" + "smithy.api#documentation": "The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
" } }, "PrivateDnsHostname": { @@ -8081,7 +8053,7 @@ } }, "traits": { - "smithy.api#documentation": "Details of an instance (also called a node interchangeably) in a\n SageMaker HyperPod cluster.
" + "smithy.api#documentation": "Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#ClusterNodeId": { @@ -8167,7 +8139,7 @@ "LastSoftwareUpdateTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The time of when SageMaker last updated the software of the instances in the cluster.
" + "smithy.api#documentation": "The time when SageMaker last updated the software of the instances in the cluster.
" } }, "InstanceStatus": { @@ -8180,7 +8152,7 @@ } }, "traits": { - "smithy.api#documentation": "Lists a summary of the properties of an instance (also called a\n node interchangeably) of a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#ClusterNonNegativeInstanceCount": { @@ -8214,13 +8186,13 @@ "target": "com.amazonaws.sagemaker#EksClusterArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod\n cluster.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration settings for the Amazon EKS cluster used as the orchestrator for the\n SageMaker HyperPod cluster.
" + "smithy.api#documentation": "The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#ClusterPrivateDnsHostname": { @@ -8450,7 +8422,7 @@ "TrainingPlanArns": { "target": "com.amazonaws.sagemaker#TrainingPlanArns", "traits": { - "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) of the training plans associated with this\n cluster.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. \n The FileSystemConfig object is not supported.
The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.
The Amazon Resource Name (ARN) of the Code Editor application \n lifecycle configuration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.
" } }, "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#AppLifecycleManagement", "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.
" + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor applications.
" } }, "BuiltInLifecycleConfigArn": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
" } } }, "traits": { - "smithy.api#documentation": "The Code Editor application settings.
\nFor more information about Code Editor, see Get started with Code \n Editor in Amazon SageMaker.
" + "smithy.api#documentation": "The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
" } }, "com.amazonaws.sagemaker#CodeRepositories": { @@ -8541,7 +8513,7 @@ } }, "traits": { - "smithy.api#documentation": "A Git repository that SageMaker AI automatically displays to users for cloning in the\n JupyterServer application.
" + "smithy.api#documentation": "A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
" } }, "com.amazonaws.sagemaker#CodeRepositoryArn": { @@ -8662,7 +8634,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
" + "smithy.api#documentation": "Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.
" } } }, @@ -8683,7 +8655,7 @@ "target": "com.amazonaws.sagemaker#CognitoUserPool", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.
", + "smithy.api#documentation": "A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.
", "smithy.api#required": {} } }, @@ -8697,7 +8669,7 @@ } }, "traits": { - "smithy.api#documentation": "Use this parameter to configure your Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" + "smithy.api#documentation": "Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
" } }, "com.amazonaws.sagemaker#CognitoMemberDefinition": { @@ -8707,7 +8679,7 @@ "target": "com.amazonaws.sagemaker#CognitoUserPool", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An identifier for a user pool. The user pool must be in the same region as the service\n that you are calling.
", + "smithy.api#documentation": "An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
", "smithy.api#required": {} } }, @@ -8723,13 +8695,13 @@ "target": "com.amazonaws.sagemaker#ClientId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An identifier for an application client. You must create the app client ID using\n Amazon Cognito.
", + "smithy.api#documentation": "An identifier for an application client. You must create the app client ID using Amazon Cognito.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Identifies a Amazon Cognito user group. A user group can be used in on or more work\n teams.
" + "smithy.api#documentation": "Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.
" } }, "com.amazonaws.sagemaker#CognitoUserGroup": { @@ -8758,7 +8730,7 @@ "VectorConfig": { "target": "com.amazonaws.sagemaker#VectorConfig", "traits": { - "smithy.api#documentation": "Configuration for your vector collection type.
\n\n Dimension: The number of elements in your vector.
Configuration for your vector collection type.
Dimension: The number of elements in your vector.
Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".
Parameter values for the tensor collection. The allowed parameters are \"name\", \"include_regex\", \"reduction_config\", \"save_config\", \"tensor_names\", and \"save_histogram\".
The type of device that the model will run on after the compilation job has\n completed.
" + "smithy.api#documentation": "The type of device that the model will run on after the compilation job has completed.
" } }, "CompilationTargetPlatformOs": { "target": "com.amazonaws.sagemaker#TargetPlatformOs", "traits": { - "smithy.api#documentation": "The type of OS that the model will run on after the compilation job has\n completed.
" + "smithy.api#documentation": "The type of OS that the model will run on after the compilation job has completed.
" } }, "CompilationTargetPlatformArch": { "target": "com.amazonaws.sagemaker#TargetPlatformArch", "traits": { - "smithy.api#documentation": "The type of architecture that the model will run on after the compilation job has\n completed.
" + "smithy.api#documentation": "The type of architecture that the model will run on after the compilation job has completed.
" } }, "CompilationTargetPlatformAccelerator": { "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", "traits": { - "smithy.api#documentation": "The type of accelerator that the model will run on after the compilation job has\n completed.
" + "smithy.api#documentation": "The type of accelerator that the model will run on after the compilation job has completed.
" } }, "LastModifiedTime": { @@ -9057,18 +9029,18 @@ "ResourceSharingConfig": { "target": "com.amazonaws.sagemaker#ResourceSharingConfig", "traits": { - "smithy.api#documentation": "Resource sharing configuration. This defines how an entity can lend and borrow idle\n compute with other entities within the cluster.
" + "smithy.api#documentation": "Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.
" } }, "PreemptTeamTasks": { "target": "com.amazonaws.sagemaker#PreemptTeamTasks", "traits": { - "smithy.api#documentation": "Allows workloads from within an entity to preempt same-team workloads. When set to\n LowerPriority, the entity's lower priority tasks are preempted by their own\n higher priority tasks.
Default is LowerPriority.
Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.
Default is LowerPriority.
Configuration of the compute allocation definition for an entity. This includes the\n resource sharing option and the setting to preempt low priority tasks.
" + "smithy.api#documentation": "Configuration of the compute allocation definition for an entity. This includes the resource sharing option and the setting to preempt low priority tasks.
" } }, "com.amazonaws.sagemaker#ComputeQuotaId": { @@ -9092,7 +9064,7 @@ "target": "com.amazonaws.sagemaker#InstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances to add to the instance group of a SageMaker HyperPod\n cluster.
", + "smithy.api#documentation": "The number of instances to add to the instance group of a SageMaker HyperPod cluster.
", "smithy.api#required": {} } } @@ -9163,7 +9135,7 @@ "ComputeQuotaConfig": { "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", "traits": { - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
" } }, "ComputeQuotaTarget": { @@ -9177,7 +9149,7 @@ "ActivationState": { "target": "com.amazonaws.sagemaker#ActivationState", "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is Enabled.
Assigned entity fair-share weight. Idle compute will be shared across entities based on\n these assigned weights. This weight is only used when FairShare is\n enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
" + "smithy.api#documentation": "Assigned entity fair-share weight. Idle compute will be shared across entities based on these assigned weights. This weight is only used when FairShare is enabled.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.
" } } }, @@ -9298,7 +9270,7 @@ } }, "traits": { - "smithy.api#documentation": "There was a conflict when you attempted to modify a SageMaker entity such as an\n Experiment or Artifact.
There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
This parameter is ignored for models that contain only a\n PrimaryContainer.
When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.
This parameter is ignored for models that contain only a PrimaryContainer.
When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nThe path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.
Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.
\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nSpecifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.
The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.
\nThe model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.
\nIf you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your Amazon Web Services account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nIf you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.
The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.
If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Specifies the location of ML model data to deploy.
Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables.
\nThe maximum length of each key and value in the Environment map is\n 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If\n you pass multiple containers to a CreateModel request, then the maximum\n length of all of their maps, combined, is also 32 KB.
The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables.
The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.
The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.
" + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to use to create the model.
" } }, "InferenceSpecificationName": { @@ -9664,7 +9636,7 @@ } }, "traits": { - "smithy.api#documentation": "Lists a summary of the properties of a context. A context provides a logical grouping\n of other entities.
" + "smithy.api#documentation": "Lists a summary of the properties of a context. A context provides a logical grouping of other entities.
" } }, "com.amazonaws.sagemaker#ContinuousParameterRange": { @@ -9682,7 +9654,7 @@ "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.
The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.
The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.
\nReverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.
\nThe scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
A flag to indicating that automatic model tuning (AMT) has detected model convergence,\n defined as a lack of significant improvement (1% or less) against an objective\n metric.
" + "smithy.api#documentation": "A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.
" } }, "com.amazonaws.sagemaker#CountryCode": { @@ -9779,7 +9751,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an action. An action is a lineage tracking entity that\n represents an action or activity. For example, a model deployment or an HPO job.\n Generally, an action involves at least one input or output artifact. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + "smithy.api#documentation": "Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
" } }, "com.amazonaws.sagemaker#CreateActionRequest": { @@ -9888,32 +9860,32 @@ "target": "com.amazonaws.sagemaker#TrainingSpecification", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies details about training jobs run by this algorithm, including the\n following:
\nThe Amazon ECR path of the container and the version digest of the\n algorithm.
\nThe hyperparameters that the algorithm supports.
\nThe instance types that the algorithm supports for training.
\nWhether the algorithm supports distributed training.
\nThe metrics that the algorithm emits to Amazon CloudWatch.
\nWhich metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.
\nThe input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.
Specifies details about training jobs run by this algorithm, including the following:
The Amazon ECR path of the container and the version digest of the algorithm.
The hyperparameters that the algorithm supports.
The instance types that the algorithm supports for training.
Whether the algorithm supports distributed training.
The metrics that the algorithm emits to Amazon CloudWatch.
Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.
Specifies details about inference jobs that the algorithm runs, including the\n following:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the algorithm supports for\n inference.
\nSpecifies details about inference jobs that the algorithm runs, including the following:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the algorithm supports for inference.
Specifies configurations for one or more training jobs and that SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that SageMaker\n runs to test the algorithm's inference code.
" + "smithy.api#documentation": "Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.
" } }, "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "Whether to certify the algorithm so that it can be listed in Amazon Web Services\n Marketplace.
" + "smithy.api#documentation": "Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -9954,7 +9926,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active\n simultaneously.
" + "smithy.api#documentation": "Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
" } }, "com.amazonaws.sagemaker#CreateAppImageConfig": { @@ -9971,7 +9943,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a configuration for running a SageMaker AI image as a KernelGateway app. The\n configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the\n kernels in the image.
" + "smithy.api#documentation": "Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
" } }, "com.amazonaws.sagemaker#CreateAppImageConfigRequest": { @@ -9994,7 +9966,7 @@ "KernelGatewayImageConfig": { "target": "com.amazonaws.sagemaker#KernelGatewayImageConfig", "traits": { - "smithy.api#documentation": "The KernelGatewayImageConfig. You can only specify one image kernel in the \n AppImageConfig API. This kernel will be shown to users before the \n image starts. Once the image runs, all kernels are visible in JupyterLab.
" + "smithy.api#documentation": "The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
" } }, "JupyterLabAppImageConfig": { @@ -10006,7 +9978,7 @@ "CodeEditorAppImageConfig": { "target": "com.amazonaws.sagemaker#CodeEditorAppImageConfig", "traits": { - "smithy.api#documentation": "The CodeEditorAppImageConfig. You can only specify one image kernel \n in the AppImageConfig API. This kernel is shown to users before the image starts. \n After the image runs, all kernels are visible in Code Editor.
The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.
The user profile name. If this value is not set, then SpaceName must be\n set.
The user profile name. If this value is not set, then SpaceName must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be set.
Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" } }, "ResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
\nThe value of InstanceType passed as part of the ResourceSpec\n in the CreateApp call overrides the value passed as part of the\n ResourceSpec configured for the user profile or the domain. If\n InstanceType is not specified in any of those three ResourceSpec\n values for a KernelGateway app, the CreateApp call fails with a\n request validation error.
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.
\n Indicates whether the application is launched in recovery mode.\n
" + "smithy.api#documentation": "Indicates whether the application is launched in recovery mode.
" } } }, @@ -10118,7 +10090,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an artifact. An artifact is a lineage tracking entity that\n represents a URI addressable object or data. Some examples are the S3 URI of a dataset and\n the ECR registry path of an image. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + "smithy.api#documentation": "Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
" } }, "com.amazonaws.sagemaker#CreateArtifactRequest": { @@ -10197,7 +10169,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nWe recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.
CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
" } }, "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { @@ -10207,7 +10179,7 @@ "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", + "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
", "smithy.api#required": {} } }, @@ -10215,7 +10187,7 @@ "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A\n minimum of 500 rows is required for the training dataset. There is not a minimum number of\n rows required for the validation dataset.
An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job. Format(s) supported: CSV.
", + "smithy.api#documentation": "Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.
", "smithy.api#required": {} } }, "ProblemType": { "target": "com.amazonaws.sagemaker#ProblemType", "traits": { - "smithy.api#documentation": "Defines the type of supervised learning problem available for the candidates. For more\n information, see \n SageMaker Autopilot problem types.
" + "smithy.api#documentation": "Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.
" } }, "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { - "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
" + "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
" } }, "AutoMLJobConfig": { @@ -10256,19 +10228,19 @@ "GenerateCandidateDefinitionsOnly": { "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", "traits": { - "smithy.api#documentation": "Generates possible candidates without training the models. A candidate is a combination\n of data preprocessors, algorithms, and algorithm parameter settings.
" + "smithy.api#documentation": "Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.
" } }, "ModelDeployConfig": { "target": "com.amazonaws.sagemaker#ModelDeployConfig", "traits": { - "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
" } } }, @@ -10309,7 +10281,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\nAn AutoML job in SageMaker AI is a fully automated process that allows you to build machine\n learning models with minimal effort and machine learning expertise. When initiating an\n AutoML job, you provide your data and optionally specify parameters tailored to your use\n case. SageMaker AI then automates the entire model development lifecycle, including data\n preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify\n and accelerate the model building process by automating various tasks and exploring\n different combinations of machine learning algorithms, data preprocessing techniques, and\n hyperparameter values. The output of an AutoML job comprises one or more trained models\n ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate\n model leaderboard, allowing you to select the best-performing model for deployment.
\nFor more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html\n in the SageMaker AI developer guide.
\nAutoML jobs V2 support various problem types such as regression, binary, and multiclass\n classification with tabular data, text and image classification, time-series forecasting,\n and fine-tuning of large language models (LLMs) for text generation.
\n\n CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob\n and DescribeAutoMLJob which offer backward compatibility.
\n\n CreateAutoMLJobV2 can manage tabular problem types identical to those of\n its previous version CreateAutoMLJob, as well as time-series forecasting,\n non-tabular problem types such as image or text classification, and text generation\n (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see\n AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.
CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.
CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).
Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.
You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
" } }, "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { @@ -10319,7 +10291,7 @@ "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case\n insensitive.
", + "smithy.api#documentation": "Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
", "smithy.api#required": {} } }, @@ -10327,7 +10299,7 @@ "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters.\n The supported formats depend on the problem type:
For tabular problem types: S3Prefix,\n ManifestFile.
For image classification: S3Prefix, ManifestFile,\n AugmentedManifestFile.
For text classification: S3Prefix.
For time-series forecasting: S3Prefix.
For text generation (LLMs fine-tuning): S3Prefix.
An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:
For tabular problem types: S3Prefix, ManifestFile.
For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.
For text classification: S3Prefix.
For time-series forecasting: S3Prefix.
For text generation (LLMs fine-tuning): S3Prefix.
Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job.
", + "smithy.api#documentation": "Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.
", "smithy.api#required": {} } }, @@ -10358,7 +10330,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, such as by purpose, owner, or environment. For more\n information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per\n resource.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.
" } }, "SecurityConfig": { @@ -10370,19 +10342,19 @@ "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { - "smithy.api#documentation": "Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.
\nFor tabular problem types: You must either provide both the\n AutoMLJobObjective and indicate the type of supervised learning\n problem in AutoMLProblemTypeConfig\n (TabularJobConfig.ProblemType), or none at all.
For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.
Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.
For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.
For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
" } }, "DataSplitConfig": { "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", "traits": { - "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
This attribute must not be set for the time-series forecasting problem type, as Autopilot\n automatically splits the input dataset into training and validation sets.
\nThis structure specifies how to split the data into train and validation datasets.
The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.
This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.
Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing\n persistent clusters for developing large machine learning models, such as large language\n models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the\n Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#CreateClusterRequest": { @@ -10454,25 +10426,25 @@ "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You\n can control access to and from your resources by configuring your VPC. For more\n information, see Give SageMaker access to resources\n in your Amazon VPC.
\nWhen your Amazon VPC and subnets support IPv6, network communications differ\n based on the cluster orchestration platform:
\nSlurm-orchestrated clusters automatically configure nodes with dual IPv6 and\n IPv4 addresses, allowing immediate IPv6 network communications.
\nIn Amazon EKS-orchestrated clusters, nodes receive dual-stack\n addressing, but pods can only use IPv6 when the Amazon EKS cluster is\n explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
\nAdditional resources for IPv6 configuration:
\nFor information about adding IPv6 support to your VPC, see to IPv6\n Support for VPC.
\nFor information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
\nTo configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
\nSpecifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can\n add tags to your cluster in the same way you add them in other Amazon Web Services services\n that support tagging. To learn more about tagging Amazon Web Services resources in general,\n see Tagging\n Amazon Web Services Resources User Guide.
" + "smithy.api#documentation": "Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.
" } }, "Orchestrator": { "target": "com.amazonaws.sagemaker#ClusterOrchestrator", "traits": { - "smithy.api#documentation": "The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported\n value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS)\n cluster as the orchestrator.
The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic,\n SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set\n to None, cluster administrators will need to manually manage any faulty\n cluster instances.
The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
Create cluster policy configuration. This policy is used for task prioritization and\n fair-share allocation of idle compute. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + "smithy.api#documentation": "Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
" } }, "com.amazonaws.sagemaker#CreateClusterSchedulerConfigRequest": { @@ -10593,7 +10565,7 @@ "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" }, "traits": { - "smithy.api#documentation": "Creates a Git repository as a resource in your SageMaker AI account. You can\n associate the repository with notebook instances so that you can use Git source control\n for the notebooks you create. The Git repository is a resource in your SageMaker AI\n account, so it can be associated with more than one notebook instance, and it persists\n independently from the lifecycle of any notebook instances it is associated with.
\nThe repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.
" + "smithy.api#documentation": "Creates a Git repository as a resource in your SageMaker AI account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.
" } }, "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { @@ -10603,7 +10575,7 @@ "target": "com.amazonaws.sagemaker#EntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Git repository. The name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } }, @@ -10611,14 +10583,14 @@ "target": "com.amazonaws.sagemaker#GitConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies details about the repository, including the URL where the repository is\n located, the default branch, and credentials to use to access the repository.
", + "smithy.api#documentation": "Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -10659,7 +10631,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
\nIf\n you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services IoT Greengrass. In that case, deploy them as an ML\n resource.
\nIn the request body, you provide the following:
\nA name for the compilation job
\nInformation about the input model artifacts
\nThe output location for the compiled model and the device (target) that the\n model runs on
\nThe Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform\n the model compilation job.
\nYou can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation\n job, use DescribeCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" + "smithy.api#documentation": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
" } }, "com.amazonaws.sagemaker#CreateCompilationJobRequest": { @@ -10677,48 +10649,48 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on\n your behalf.
\nDuring model compilation, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker AI\n Roles.\n
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
During model compilation, Amazon SageMaker AI needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.
The Amazon Resource Name (ARN) of a versioned model package. Provide either a \n ModelPackageVersionArn or an InputConfig object in the \n request syntax. The presence of both objects in the CreateCompilationJob \n request will return an exception.
The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.
" + "smithy.api#documentation": "Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
" } }, "OutputConfig": { "target": "com.amazonaws.sagemaker#OutputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides information about the output location for the compiled model and the target\n device the model runs on.
", + "smithy.api#documentation": "Provides information about the output location for the compiled model and the target device the model runs on.
", "smithy.api#required": {} } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#NeoVpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", + "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -10733,7 +10705,7 @@ "target": "com.amazonaws.sagemaker#CompilationJobArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns\n the following data in JSON format:
\n\n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.
If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns the following data in JSON format:
CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.
Create compute allocation definition. This defines how compute is allocated, shared, and\n borrowed for specified entities. Specifically, how to lend and borrow idle compute and\n assign a fair-share weight to the specified entities.
" + "smithy.api#documentation": "Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.
" } }, "com.amazonaws.sagemaker#CreateComputeQuotaRequest": { @@ -10791,7 +10763,7 @@ "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
", + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
", "smithy.api#required": {} } }, @@ -10806,7 +10778,7 @@ "ActivationState": { "target": "com.amazonaws.sagemaker#ActivationState", "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is Enabled.
Creates a context. A context is a lineage tracking entity that\n represents a logical grouping of other tracking or experiment entities. Some examples are\n an endpoint and a model package. For more information, see\n Amazon SageMaker\n ML Lineage Tracking.
" + "smithy.api#documentation": "Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
" } }, "com.amazonaws.sagemaker#CreateContextRequest": { @@ -10942,7 +10914,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" + "smithy.api#documentation": "Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
" } }, "com.amazonaws.sagemaker#CreateDataQualityJobDefinitionRequest": { @@ -10974,7 +10946,7 @@ "target": "com.amazonaws.sagemaker#DataQualityJobInput", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of inputs for the monitoring job. Currently endpoints are supported as monitoring\n inputs.
", + "smithy.api#documentation": "A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
", "smithy.api#required": {} } }, @@ -11002,7 +10974,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -11012,7 +10984,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -11096,7 +11068,7 @@ "EnableIotRoleAlias": { "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", "traits": { - "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" + "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".
For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".
" } } }, @@ -11121,7 +11093,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Domain. A domain consists of an associated Amazon Elastic File System\n volume, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\n and other artifacts with each other.
\n EFS storage\n
\nWhen a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.
\nSageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services\n KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key\n by default. For more control, you can specify a customer managed key. For more information,\n see Protect Data\n at Rest Using Encryption.
\n\n VPC configuration\n
\nAll traffic between the domain and the Amazon EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:
\n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker AI, which allows internet access. This is the default value.
\n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker AI\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker AI API and runtime or a NAT gateway and your security groups allow\n outbound connections.
\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker AI Studio app successfully.
\nFor more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
" + "smithy.api#documentation": "Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.
VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.
For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
" } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -11147,7 +11119,7 @@ "target": "com.amazonaws.sagemaker#UserSettings", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The default settings to use to create a user profile when UserSettings isn't\n specified in the call to the CreateUserProfile API.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag\n keys must be unique per resource. Tags are searchable using the Search\n API.
Tags that you specify for the Domain are also added to all Apps that the Domain\n launches.
" + "smithy.api#documentation": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
Tags that you specify for the Domain are also added to all Apps that the Domain launches.
" } }, "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
VpcOnly - All traffic is through the specified VPC and subnets
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to\n the domain with an Amazon Web Services managed key by default. For more control, specify a\n customer managed key.
" + "smithy.api#documentation": "SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
" } }, "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a\n different deployment configuration and devices.
" + "smithy.api#documentation": "Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
" } }, "com.amazonaws.sagemaker#CreateEdgeDeploymentPlanRequest": { @@ -11296,7 +11268,7 @@ "Stages": { "target": "com.amazonaws.sagemaker#DeploymentStages", "traits": { - "smithy.api#documentation": "List of stages of the edge deployment plan. The number of stages is limited to 10 per\n deployment.
" + "smithy.api#documentation": "List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.
" } }, "Tags": { @@ -11466,7 +11438,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\n You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint\n API.
Use this API if you want to use SageMaker hosting services to deploy models into\n production.
\nIn the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n
Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
Specifies configuration for how an endpoint performs asynchronous inference. This is a\n required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
" + "smithy.api#documentation": "Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
" } }, "ExplainerConfig": { @@ -11535,13 +11507,13 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { - "smithy.api#documentation": "An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI\n Roles.
\nTo be able to pass this role to Amazon SageMaker AI, the caller of this action must\n have the iam:PassRole permission.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI Roles.
To be able to pass this role to Amazon SageMaker AI, the caller of this action must have the iam:PassRole permission.
Sets whether all model containers deployed to the endpoint are isolated. If they are, no\n inbound or outbound network calls can be made to or from the model containers.
" + "smithy.api#documentation": "Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
" } } }, @@ -11581,7 +11553,7 @@ "target": "com.amazonaws.sagemaker#EndpointName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -11637,7 +11609,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.
\nIn the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.
\nThe goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
\nTo add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" + "smithy.api#documentation": "Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
" } }, "com.amazonaws.sagemaker#CreateExperimentRequest": { @@ -11647,14 +11619,14 @@ "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the experiment. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#documentation": "The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If you don't\n specify DisplayName, the value in ExperimentName is\n displayed.
The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.
A list of tags to associate with the experiment. You can use Search API\n to search on the tags.
" + "smithy.api#documentation": "A list of tags to associate with the experiment. You can use Search API to search on the tags.
" } } }, @@ -11705,7 +11677,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.
The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list\n of Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.
Note that it can take approximately 10-15 minutes to provision an\n OnlineStore\n FeatureGroup with the InMemory\n StorageType.
You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.
Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.
The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.
Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
The name:
Must start with an alphanumeric character.
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureStore. Only the latest record per\n identifier value will be stored in the OnlineStore.\n RecordIdentifierFeatureName must be one of feature definitions'\n names.
You use the RecordIdentifierFeatureName to access data in a\n FeatureStore.
This name:
\nMust start with an alphanumeric character.
\nCan only contains alphanumeric characters, hyphens, underscores. Spaces are not\n allowed.
\nThe name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.
You use the RecordIdentifierFeatureName to access data in a FeatureStore.
This name:
Must start with an alphanumeric character.
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
The name of the feature that stores the EventTime of a Record\n in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to\n the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
An EventTime can be a String or Fractional.
\n Fractional: EventTime feature values must be a Unix\n timestamp in seconds.
\n String: EventTime feature values must be an ISO-8601\n string in the format. The following formats are supported\n yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ\n where yyyy, MM, and dd represent the year,\n month, and day respectively and HH, mm, ss,\n and if applicable, SSS represent the hour, month, second and\n milliseconds respsectively. 'T' and Z are constants.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.
An EventTime can be a String or Fractional.
Fractional: EventTime feature values must be a Unix timestamp in seconds.
String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.
A list of Feature names and types. Name and Type\n is compulsory per Feature.
Valid feature FeatureTypes are Integral,\n Fractional and String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time\n
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
A list of Feature names and types. Name and Type is compulsory per Feature.
Valid feature FeatureTypes are Integral, Fractional and String.
FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time
You can create up to 2,500 FeatureDefinitions per FeatureGroup.
You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig.
You can also include an Amazon Web Services KMS key ID (KMSKeyId) for\n at-rest encryption of the OnlineStore.
The default value is False.
You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.
You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.
The default value is False.
Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:
The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data\n catalog.
\nAn KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we\n encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level\n key for SSE, you can reduce Amazon Web Services KMS requests costs by up to\n 99 percent.
Format for the offline store table. Supported formats are Glue (Default) and\n Apache Iceberg.
\nTo learn more about this parameter, see OfflineStoreConfig.
" + "smithy.api#documentation": "Use this to configure an OfflineFeatureStore. This parameter allows you to specify:
The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.
A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.
Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.
To learn more about this parameter, see OfflineStoreConfig.
" } }, "ThroughputConfig": { @@ -11761,7 +11733,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique\n identifier for the feature group.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" + "smithy.api#documentation": "Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" } }, "HumanLoopActivationConfig": { @@ -12144,7 +12116,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.
\nA hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility model, \n you are responsible for any potential exposure, unauthorized access, or \n compromise of your sensitive data if caused by any security-sensitive information included \n in the request hyperparameter variable or plain text fields..
\nStarts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..
The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid\n characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case\n sensitive.
", + "smithy.api#documentation": "The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
", "smithy.api#required": {} } }, @@ -12162,38 +12134,38 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterTuningJobConfig object that describes the tuning job,\n including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.
", + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.
", "smithy.api#required": {} } }, "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the training jobs\n that this tuning job launches, including static hyperparameters, input data\n configuration, output data configuration, resource configuration, and stopping\n condition.
" + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
" } }, "TrainingJobDefinitions": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
" } }, "WarmStartConfig": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", "traits": { - "smithy.api#documentation": "Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nSpecifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
\nTags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
" } }, "Autotune": { "target": "com.amazonaws.sagemaker#Autotune", "traits": { - "smithy.api#documentation": "Configures SageMaker Automatic model tuning (AMT) to automatically find optimal\n parameters for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nConfigures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:
ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.
ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.
TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.
RetryStrategy: The number of times to retry a training job.
Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.
ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.
The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
", "smithy.api#required": {} } } @@ -12234,7 +12206,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image\n version represents a container image stored in Amazon ECR. For more information, see\n Bring your own SageMaker AI image.
" + "smithy.api#documentation": "Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.
" } }, "com.amazonaws.sagemaker#CreateImageRequest": { @@ -12313,7 +12285,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a version of the SageMaker AI image specified by ImageName. The version\n represents the Amazon ECR container image specified by BaseImage.
Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.
The registry path of the container image to use as the starting point for this\n version. The path is an Amazon ECR URI in the following format:
\n\n
The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.
", + "smithy.api#documentation": "A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -12353,13 +12325,13 @@ "VendorGuidance": { "target": "com.amazonaws.sagemaker#VendorGuidance", "traits": { - "smithy.api#documentation": "The stability of the image version, specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
The stability of the image version, specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable.
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates SageMaker AI job type compatibility.
TRAINING: The image version is compatible with SageMaker AI training jobs.
INFERENCE: The image version is compatible with SageMaker AI inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
Creates an inference component, which is a SageMaker AI hosting object that you can\n use to deploy a model to an endpoint. In the inference component settings, you specify the\n model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You\n can optimize resource utilization by tailoring how the required CPU cores, accelerators,\n and memory are allocated. You can deploy multiple inference components to an endpoint,\n where each inference component contains one model and the resource utilization needs for\n that individual model. After you deploy an inference component, you can directly invoke the\n associated model when you use the InvokeEndpoint API action.
" + "smithy.api#documentation": "Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
" } }, "com.amazonaws.sagemaker#CreateInferenceComponentInput": { @@ -12450,14 +12422,14 @@ "VariantName": { "target": "com.amazonaws.sagemaker#VariantName", "traits": { - "smithy.api#documentation": "The name of an existing production variant where you host the inference\n component.
" + "smithy.api#documentation": "The name of an existing production variant where you host the inference component.
" } }, "Specification": { "target": "com.amazonaws.sagemaker#InferenceComponentSpecification", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
", + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the model, container, and compute resources.
", "smithy.api#required": {} } }, @@ -12470,7 +12442,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General\n Reference.
" + "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
" } } }, @@ -12511,7 +12483,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates an inference experiment using the configurations specified in the request.\n
\n\n Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\n more information about inference experiments, see Shadow tests.\n
\n\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n
\n\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n
" + "smithy.api#documentation": "Creates an inference experiment using the configurations specified in the request.
Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.
Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.
" } }, "com.amazonaws.sagemaker#CreateInferenceExperimentRequest": { @@ -12529,14 +12501,14 @@ "target": "com.amazonaws.sagemaker#InferenceExperimentType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n
\n\n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n
The type of the inference experiment that you want to run. The following types of experiments are possible:
ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.
\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically starts immediately upon creation and concludes after 7 days.\n
" + "smithy.api#documentation": "The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.
" } }, "Description": { @@ -12549,7 +12521,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
", + "smithy.api#documentation": "The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
", "smithy.api#required": {} } }, @@ -12557,7 +12529,7 @@ "target": "com.amazonaws.sagemaker#EndpointName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.\n
", + "smithy.api#documentation": "The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
", "smithy.api#required": {} } }, @@ -12565,34 +12537,34 @@ "target": "com.amazonaws.sagemaker#ModelVariantConfigList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n An array of ModelVariantConfig objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfig object in the array describes the infrastructure\n configuration for the corresponding variant.\n
An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.
\n The Amazon S3 location and configuration for storing inference request and response data.\n
\n\n This is an optional parameter that you can use for data capture. For more information, see Capture data.\n
" + "smithy.api#documentation": "The Amazon S3 location and configuration for storing inference request and response data.
This is an optional parameter that you can use for data capture. For more information, see Capture data.
" } }, "ShadowModeConfig": { "target": "com.amazonaws.sagemaker#ShadowModeConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can\n be any of the following formats:\n
KMS key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS key Alias
\n\n \"alias/ExampleAlias\"\n
Amazon Resource Name (ARN) of a KMS key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n
\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:
KMS key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS key Alias
\"alias/ExampleAlias\"
Amazon Resource Name (ARN) of a KMS key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
\n Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different\n ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.\n
" + "smithy.api#documentation": "Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.
" } } }, @@ -12633,7 +12605,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a recommendation job. You can create either an instance \n recommendation or load test job.
" + "smithy.api#documentation": "Starts a recommendation job. You can create either an instance recommendation or load test job.
" } }, "com.amazonaws.sagemaker#CreateInferenceRecommendationsJobRequest": { @@ -12643,7 +12615,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A name for the recommendation job. The name must be unique within \n the Amazon Web Services Region and within your Amazon Web Services account.\n The job name is passed down to the resources created by the recommendation job.\n The names of resources (such as the model, endpoint configuration, endpoint, and compilation)\n that are prefixed with the job name are truncated at 40 characters.
", + "smithy.api#documentation": "A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.
", "smithy.api#required": {} } }, @@ -12651,7 +12623,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Defines the type of recommendation job. Specify Default to initiate an instance \n recommendation and Advanced to initiate a load test. If left unspecified, \n Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -12667,7 +12639,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations.
", + "smithy.api#documentation": "Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
", "smithy.api#required": {} } }, @@ -12680,19 +12652,19 @@ "StoppingConditions": { "target": "com.amazonaws.sagemaker#RecommendationJobStoppingConditions", "traits": { - "smithy.api#documentation": "A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.
" + "smithy.api#documentation": "A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
" } }, "OutputConfig": { "target": "com.amazonaws.sagemaker#RecommendationJobOutputConfig", "traits": { - "smithy.api#documentation": "Provides information about the output artifacts and the KMS key \n to use for Amazon S3 server-side encryption.
" + "smithy.api#documentation": "Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "The metadata that you apply to Amazon Web Services resources to help you \n categorize and organize them. Each tag consists of a key and a value, both of \n which you define. For more information, see \n Tagging Amazon Web Services Resources \n in the Amazon Web Services General Reference.
" + "smithy.api#documentation": "The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
" } } }, @@ -12733,7 +12705,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.
\nYou can select your workforce from one of three providers:
\nA private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.
\nOne or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.
\nThe Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.
\nYou can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.
\nThe data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.
\nThe output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.
\nYou can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.
Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.
The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.
The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.
The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.
The name can't end with \"-metadata\".
\nIf you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".
\nImage semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.
Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.
Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.
3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.
3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.
The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.
The name can't end with \"-metadata\".
If you are using one of the following built-in task types, the attribute name must end with \"-ref\". If the task type you are using is not listed below, the attribute name must not end with \"-ref\".
Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.
Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.
Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.
3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.
3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.
Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.
\nYou must specify at least one of the following: S3DataSource or\n SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.
If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.
Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.
The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt\n the output data, if any.
", + "smithy.api#documentation": "The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
", "smithy.api#required": {} } }, @@ -12775,20 +12747,20 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.
", + "smithy.api#documentation": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
", "smithy.api#required": {} } }, "LabelCategoryConfigS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.
\nFor 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
\nFor named entity recognition jobs, in addition to Add Instructions Add additional instructions.\"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\". For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .Add header
For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.
\n { \n
\n \"document-version\": \"2018-11-28\",\n
\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n
\n }\n
Note the following about the label category configuration file:
\nFor image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.
\nEach label category must be unique, you cannot specify duplicate label\n categories.
\nIf you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.
The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.
For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For named entity recognition jobs, in addition to \"labels\", you must provide worker instructions in the label category configuration file using the \"instructions\" parameter: \"instructions\": {\"shortInstruction\":\"<h1>Add header</h1><p>Add Instructions</p>\", \"fullInstruction\":\"<p>Add additional instructions.</p>\"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
{
\"document-version\": \"2018-11-28\",
\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]
}
Note the following about the label category configuration file:
For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.
Each label category must be unique, you cannot specify duplicate label categories.
If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.
A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.
" + "smithy.api#documentation": "A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
" } }, "LabelingJobAlgorithmsConfig": { @@ -12808,7 +12780,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.
" + "smithy.api#documentation": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -12823,7 +12795,7 @@ "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the\n labeling job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
", "smithy.api#required": {} } } @@ -12846,7 +12818,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact\n store. For more information, see Create an MLflow Tracking\n Server.
" + "smithy.api#documentation": "Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.
" } }, "com.amazonaws.sagemaker#CreateMlflowTrackingServerRequest": { @@ -12856,7 +12828,7 @@ "target": "com.amazonaws.sagemaker#TrackingServerName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server\n ARN.
", + "smithy.api#documentation": "A unique string identifying the tracking server name. This string is part of the tracking server ARN.
", "smithy.api#required": {} } }, @@ -12864,34 +12836,34 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact\n store.
", + "smithy.api#documentation": "The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
", "smithy.api#required": {} } }, "TrackingServerSize": { "target": "com.amazonaws.sagemaker#TrackingServerSize", "traits": { - "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between\n \"Small\", \"Medium\", and \"Large\". The default MLflow\n Tracking Server configuration size is \"Small\". You can choose a size depending on\n the projected use of the tracking server such as the volume of data logged, number of users,\n and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking\n server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" + "smithy.api#documentation": "The size of the tracking server you want to create. You can choose between \"Small\", \"Medium\", and \"Large\". The default MLflow Tracking Server configuration size is \"Small\". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.
We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
" } }, "MlflowVersion": { "target": "com.amazonaws.sagemaker#MlflowVersion", "traits": { - "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are\n available to use, see How it works.
" + "smithy.api#documentation": "The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.
" } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to\n access the artifact store in Amazon S3. The role should have AmazonS3FullAccess\n permissions. For more information on IAM permissions for tracking server creation, see\n Set up IAM permissions for MLflow.
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.
\nUse this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.
\nTo host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" + "smithy.api#documentation": "Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.
Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.
To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -12969,7 +12941,7 @@ "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -13019,7 +12991,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -13029,7 +13001,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -13070,7 +13042,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon SageMaker Model Card.
\nFor information about how to use model cards, see Amazon SageMaker Model Card.
" + "smithy.api#documentation": "Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
" } }, "com.amazonaws.sagemaker#CreateModelCardExportJob": { @@ -13164,7 +13136,7 @@ "SecurityConfig": { "target": "com.amazonaws.sagemaker#ModelCardSecurityConfig", "traits": { - "smithy.api#documentation": "An optional Key Management Service \n key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with\n highly sensitive data.
" + "smithy.api#documentation": "An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.
" } }, "Content": { @@ -13179,7 +13151,7 @@ "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -13287,7 +13259,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -13297,7 +13269,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -13335,7 +13307,7 @@ "PrimaryContainer": { "target": "com.amazonaws.sagemaker#ContainerDefinition", "traits": { - "smithy.api#documentation": "The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.
" + "smithy.api#documentation": "The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
" } }, "Containers": { @@ -13353,25 +13325,25 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your model to connect\n to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.
A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" + "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
" } } }, @@ -13412,7 +13384,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers\n can subscribe to model packages listed on Amazon Web Services Marketplace to create\n models in SageMaker.
\nTo create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.
There are two types of model packages:
\nVersioned - a model that is part of a model group in the model\n registry.
\nUnversioned - a model package that is not part of a model group.
\nCreates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.
There are two types of model packages:
Versioned - a model that is part of a model group in the model registry.
Unversioned - a model package that is not part of a model group.
A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + "smithy.api#documentation": "A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } } }, @@ -13482,13 +13454,13 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).
\nThis parameter is required for unversioned models. It is not applicable to versioned\n models.
" + "smithy.api#documentation": "The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
" } }, "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs\n to.
\nThis parameter is required for versioned models, and does not apply to unversioned\n models.
" + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
" } }, "ModelPackageDescription": { @@ -13500,13 +13472,13 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this\n model package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies details about inference jobs that you can run with models based on this model package, including the following information:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
Specifies configurations for one or more transform jobs that SageMaker runs to test the\n model package.
" + "smithy.api#documentation": "Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
" } }, "SourceAlgorithmSpecification": { @@ -13518,19 +13490,19 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services\n Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" + "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
\nIf you supply ModelPackageGroupName, your model package belongs to the\n model group you specify and uses the tags associated with the model group. In this case,\n you cannot supply a tag argument.
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
Whether the model is approved for deployment.
\nThis parameter is optional for versioned models, and does not apply to unversioned\n models.
\nFor versioned models, the value of this parameter must be set to Approved\n to deploy the model.
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the model.
The machine learning domain of your model package and its components. Common machine\n learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning\n tasks include object detection and image classification. The following tasks are\n supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" |\n \"OBJECT_DETECTION\" | \"TEXT_GENERATION\"\n |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" |\n \"CLASSIFICATION\" | \"REGRESSION\" |\n \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a\n single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple\n files that are all equally used in the load test. Each file in the archive must satisfy\n the size constraints of the InvokeEndpoint call.
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
" } }, "CustomerMetadataProperties": { @@ -13576,13 +13548,13 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker\n Pipelines in the Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference\n Specification specifies artifacts based on this model package that can be used on\n inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.\n
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" } }, "SkipModelValidation": { @@ -13594,19 +13566,19 @@ "SourceUri": { "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", "traits": { - "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package, set\n it to the model package Amazon Resource Name (ARN). If you want to register a model, set\n it to the model ARN.
" + "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
" } }, "SecurityConfig": { "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
Creates a definition for a job that monitors model quality and drift. For information\n about model monitor, see Amazon SageMaker AI Model\n Monitor.
" + "smithy.api#documentation": "Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
" } }, "com.amazonaws.sagemaker#CreateModelQualityJobDefinitionRequest": { @@ -13713,7 +13685,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -13723,7 +13695,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see \n \n Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -13764,7 +13736,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to\n monitor the data captured for an Amazon SageMaker AI Endpoint.
" + "smithy.api#documentation": "Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
" } }, "com.amazonaws.sagemaker#CreateMonitoringScheduleRequest": { @@ -13774,7 +13746,7 @@ "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -13782,14 +13754,14 @@ "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring job.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost\n Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -13827,7 +13799,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an SageMaker AI notebook instance. A notebook instance is a machine\n learning (ML) compute instance running on a Jupyter notebook.
\nIn a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker AI launches the instance, installs common\n libraries that you can use to explore datasets for model training, and attaches an ML\n storage volume to the notebook instance.
SageMaker AI also provides a set of example notebooks. Each notebook\n demonstrates how to use SageMaker AI with a specific algorithm or with a machine\n learning framework.
\nAfter receiving the request, SageMaker AI does the following:
\nCreates a network interface in the SageMaker AI VPC.
\n(Option) If you specified SubnetId, SageMaker AI creates\n a network interface in your own VPC, which is inferred from the subnet ID that\n you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network\n interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the\n SageMaker AI VPC. If you specified SubnetId of your VPC,\n SageMaker AI specifies both network interfaces when launching this\n instance. This enables inbound traffic from your own VPC to the notebook\n instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker AI returns its Amazon Resource\n Name (ARN). You can't change the name of a notebook instance after you create\n it.
\nAfter SageMaker AI creates the notebook instance, you can connect to the\n Jupyter server and work in Jupyter notebooks. For example, you can write code to explore\n a dataset that you can use for model training, train a model, host models by creating\n SageMaker AI endpoints, and validate hosted models.
\nFor more information, see How It Works.
" + "smithy.api#documentation": "Creates an SageMaker AI notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker AI launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.
SageMaker AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker AI does the following:
Creates a network interface in the SageMaker AI VPC.
(Option) If you specified SubnetId, SageMaker AI creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified SubnetId of your VPC, SageMaker AI specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.
After creating the notebook instance, SageMaker AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker AI creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker AI endpoints, and validate hosted models.
For more information, see How It Works.
" } }, "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { @@ -13852,75 +13824,75 @@ "SubnetId": { "target": "com.amazonaws.sagemaker#SubnetId", "traits": { - "smithy.api#documentation": "The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.
" + "smithy.api#documentation": "The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.
" + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
" } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker AI assumes this role to perform tasks on your behalf. You must\n grant this role necessary permissions so SageMaker AI can perform these tasks. The\n policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com)\n permissions to assume this role. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker AI uses to encrypt data on the storage volume attached to your\n notebook instance. The KMS key you provide must be enabled. For information, see Enabling and\n Disabling Keys in the Amazon Web Services Key Management Service\n Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } }, "LifecycleConfigName": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" + "smithy.api#documentation": "The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "Sets whether SageMaker AI provides internet access to the notebook instance. If\n you set this to Disabled this notebook instance is able to access resources\n only in your VPC, and is not be able to connect to SageMaker AI training and\n endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.
Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.
" + "smithy.api#documentation": "The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
" } }, "AcceleratorTypes": { "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of EI instance types to associate with this\n notebook instance.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of EI instance types to associate with this notebook instance.
" } }, "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nWhether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.
Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + "smithy.api#documentation": "Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { @@ -13971,19 +13943,19 @@ "OnCreate": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { - "smithy.api#documentation": "A shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" + "smithy.api#documentation": "A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
" } }, "OnStart": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { - "smithy.api#documentation": "A shell script that runs every time you start a notebook instance, including when you\n create the notebook instance. The shell script must be a base64-encoded string.
" + "smithy.api#documentation": "A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -14036,7 +14008,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a job that optimizes a model for inference performance. To create the job, you\n provide the location of a source model, and you provide the settings for the optimization\n techniques that you want the job to apply. When the job completes successfully, SageMaker\n uploads the new optimized model to the output destination that you specify.
\nFor more information about how to use this action, and about the supported optimization\n techniques, see Optimize model inference with Amazon SageMaker.
" + "smithy.api#documentation": "Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.
For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.
" } }, "com.amazonaws.sagemaker#CreateOptimizationJobRequest": { @@ -14054,7 +14026,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
\nDuring model optimization, Amazon SageMaker AI needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this\n role to Amazon SageMaker AI, the caller of this API must have the\n iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.\n
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
During model optimization, Amazon SageMaker AI needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.
A list of key-value pairs associated with the optimization job. For more information,\n see Tagging Amazon Web Services resources in the Amazon Web Services General Reference\n Guide.
" + "smithy.api#documentation": "A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } }, "VpcConfig": { @@ -14245,7 +14217,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a\n customer managed key.
" + "smithy.api#documentation": "SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.
" } }, "MaintenanceConfig": { @@ -14292,7 +14264,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" } } }, @@ -14357,13 +14329,13 @@ "PipelineDefinition": { "target": "com.amazonaws.sagemaker#PipelineDefinition", "traits": { - "smithy.api#documentation": "The JSON \n pipeline definition of the pipeline.
" + "smithy.api#documentation": "The JSON pipeline definition of the pipeline.
" } }, "PipelineDefinitionS3Location": { "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", "traits": { - "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
" } }, "PipelineDescription": { @@ -14376,7 +14348,7 @@ "target": "com.amazonaws.sagemaker#IdempotencyToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -14398,7 +14370,7 @@ "ParallelismConfiguration": { "target": "com.amazonaws.sagemaker#ParallelismConfiguration", "traits": { - "smithy.api#documentation": "This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.
" + "smithy.api#documentation": "This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
" } } }, @@ -14434,7 +14406,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker AI\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a\n default timeout of 5 minutes. You can configure this value using\n ExpiresInSeconds. If you try to use the URL after the timeout limit\n expires, you are directed to the Amazon Web Services console sign-in page.
The JupyterLab session default expiration time is 12 hours. You can configure this\n value using SessionExpirationDurationInSeconds.
\nCreates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.
The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.
You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint .
The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.
The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.
The landing page that the user is directed to when accessing the presigned URL. Using this\n value, users can access Studio or Studio Classic, even if it is not the default experience for\n the domain. The supported values are:
\n\n studio::relative/path: Directs users to the relative path in\n Studio.
\n app:JupyterServer:relative/path: Directs users to the relative path in\n the Studio Classic application.
\n app:JupyterLab:relative/path: Directs users to the relative path in the\n JupyterLab application.
\n app:RStudioServerPro:relative/path: Directs users to the relative path in\n the RStudio application.
\n app:CodeEditor:relative/path: Directs users to the relative path in the\n Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
\n app:Canvas:relative/path: Directs users to the relative path in the\n Canvas application.
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
studio::relative/path: Directs users to the relative path in Studio.
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
Returns a presigned URL that you can use to connect to the MLflow UI attached to your\n tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" + "smithy.api#documentation": "Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.
" } }, "com.amazonaws.sagemaker#CreatePresignedMlflowTrackingServerUrlRequest": { @@ -14530,7 +14502,7 @@ "ExpiresInSeconds": { "target": "com.amazonaws.sagemaker#ExpiresInSeconds", "traits": { - "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used\n only once.
" + "smithy.api#documentation": "The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.
" } }, "SessionExpirationDurationInSeconds": { @@ -14567,7 +14539,7 @@ "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" }, "traits": { - "smithy.api#documentation": "Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker AI console, when you choose Open next to a\n notebook instance, SageMaker AI opens a new tab showing the Jupyter server home\n page from the notebook instance. The console uses this API to get the URL and show the\n page.
The IAM role or user used to call this API defines the permissions to\n access the notebook instance. Once the presigned URL is created, no additional\n permission is required to access this URL. IAM authorization policies for\n this API are also enforced for every HTTP request and WebSocket frame that attempts to\n connect to the notebook instance.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you\n try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
\nReturns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose Open next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
An array of inputs configuring the data to download into the processing\n container.
" + "smithy.api#documentation": "An array of inputs configuring the data to download into the processing container.
" } }, "ProcessingOutputConfig": { @@ -14648,7 +14620,7 @@ "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -14656,7 +14628,7 @@ "target": "com.amazonaws.sagemaker#ProcessingResources", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
", "smithy.api#required": {} } }, @@ -14677,27 +14649,27 @@ "Environment": { "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. Up to 100 key and values\n entries in the map are supported.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request environment variable or plain text fields.
\nThe environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
Networking options for a processing job, such as whether to allow inbound and outbound\n network calls to and from processing containers, and the VPC subnets and security groups\n to use for VPC-enabled processing jobs.
" + "smithy.api#documentation": "Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
" } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and\n Cost Management User Guide.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any tags. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request tag variable or plain text fields.
\n(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.
Creates a machine learning (ML) project that can contain one or more templates that set\n up an ML pipeline from training to deploying an approved model.
" + "smithy.api#documentation": "Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
" } }, "com.amazonaws.sagemaker#CreateProjectInput": { @@ -14761,13 +14733,13 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
" + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs that you want to use to organize and track your Amazon Web Services\n resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } } }, @@ -14841,7 +14813,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Tags to associated with the space. Each tag consists of a key and an optional value. Tag\n keys must be unique for each resource. Tags are searchable using the Search\n API.
Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.
The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This\n content must be base64 encoded.
", + "smithy.api#documentation": "The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.
", "smithy.api#required": {} } }, @@ -14934,7 +14906,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an\n optional value. Tag keys must be unique per resource. Tags are searchable using the Search\n API.
" + "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
" } } }, @@ -14976,7 +14948,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request hyperparameter variable or plain text fields.
\n\n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility model, you are \n responsible for any potential exposure, unauthorized access, or compromise of your sensitive\n data if caused by security-sensitive information included in the request environment variable \n or plain text fields.
\n\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" + "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" } }, "com.amazonaws.sagemaker#CreateTrainingJobRequest": { @@ -14986,21 +14958,21 @@ "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the training job. The name must be unique within an Amazon Web Services\n Region in an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
", "smithy.api#required": {} } }, "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise \n of your sensitive data if caused by any security-sensitive information included in the \n request hyperparameter variable or plain text fields.
\nAlgorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.
The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
", + "smithy.api#documentation": "The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
", "smithy.api#required": {} } }, @@ -15008,21 +14980,21 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.
\nDuring model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.
\nTo be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.
The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.
During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.
\nYour input must be in the same Amazon Web Services region as your training\n job.
" + "smithy.api#documentation": "An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.
Your input must be in the same Amazon Web Services region as your training job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the path to the S3 location where you want to store model artifacts. SageMaker\n creates subfolders for the artifacts.
", + "smithy.api#documentation": "Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
", "smithy.api#required": {} } }, @@ -15030,52 +15002,52 @@ "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use\n for model training.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.
The resources, including the ML compute instances and ML storage volumes, to use for model training.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
A VpcConfig object that specifies the VPC that you want your training job to\n connect to. Control access to and from your training container by configuring the VPC.\n For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any tags. As part of the shared responsibility model, you are \n responsible for any potential exposure, unauthorized access, or compromise \n of your sensitive data if caused by any security-sensitive information included in the \n request tag variable or plain text fields.
\nAn array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.
Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" + "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
" } }, "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.
" + "smithy.api#documentation": "To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
" } }, "CheckpointConfig": { "target": "com.amazonaws.sagemaker#CheckpointConfig", "traits": { - "smithy.api#documentation": "Contains information about the output location for managed spot training checkpoint\n data.
" + "smithy.api#documentation": "Contains information about the output location for managed spot training checkpoint data.
" } }, "DebugHookConfig": { @@ -15099,25 +15071,25 @@ "ProfilerRuleConfigurations": { "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
" } }, "Environment": { "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
\nDo not include any security-sensitive information including account access IDs, \n secrets, or tokens in any environment fields. As part of the shared responsibility model, \n you are responsible for any potential exposure, unauthorized access, or compromise of your \n sensitive data if caused by security-sensitive information included in the request environment variable\n or plain text fields.
\nThe environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The number of times to retry the job when the job fails due to an\n InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + "smithy.api#documentation": "Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
" } }, "InfraCheckConfig": { @@ -15129,7 +15101,7 @@ "SessionChainingConfig": { "target": "com.amazonaws.sagemaker#SessionChainingConfig", "traits": { - "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for the training\n job.
" + "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for the training job.
" } } }, @@ -15173,7 +15145,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new training plan in SageMaker to reserve compute capacity.
\nAmazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU\n capacity for large-scale AI model training. It provides a way to secure predictable access\n to computational resources within specific timelines and budgets, without the need to\n manage underlying infrastructure.
\n\n How it works\n
\nPlans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod\n clusters, automatically provisioning resources, setting up infrastructure, executing\n workloads, and handling infrastructure failures.
\n\n Plan creation workflow\n
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration) using the \n SearchTrainingPlanOfferings\n API operation.
They create a plan that best matches their needs using the ID of the plan offering\n they want to use.
\nAfter successful upfront payment, the plan's status becomes\n Scheduled.
The plan can be used to:
\nQueue training jobs.
\nAllocate to an instance group of a SageMaker HyperPod cluster.
\nWhen the plan start date arrives, it becomes Active. Based on\n available reserved capacity:
Training jobs are launched.
\nInstance groups are provisioned.
\n\n Plan composition\n
\nA plan can consist of one or more Reserved Capacities, each defined by a specific\n instance type, quantity, Availability Zone, duration, and start and end times. For more\n information about Reserved Capacity, see \n ReservedCapacitySummary\n .
Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.
They create a plan that best matches their needs using the ID of the plan offering they want to use.
After successful upfront payment, the plan's status becomes Scheduled.
The plan can be used to:
Queue training jobs.
Allocate to an instance group of a SageMaker HyperPod cluster.
When the plan start date arrives, it becomes Active. Based on available reserved capacity:
Training jobs are launched.
Instance groups are provisioned.
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .
The unique identifier of the training plan offering to use for creating this\n plan.
", + "smithy.api#documentation": "The unique identifier of the training plan offering to use for creating this plan.
", "smithy.api#required": {} } }, @@ -15242,7 +15214,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.
\nTo perform batch transformations, you create a transform job and use the data that you\n have readily available.
\nIn the request body, you provide the following:
\n\n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.
\n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.
\n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.
\n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.
\n TransformResources - Identifies the ML compute instances and AMI\n image versions for the transform job.
For more information about how batch transformation works, see Batch\n Transform.
" + "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
" } }, "com.amazonaws.sagemaker#CreateTransformJobRequest": { @@ -15252,7 +15224,7 @@ "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the transform job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.
", + "smithy.api#documentation": "The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -15260,45 +15232,45 @@ "target": "com.amazonaws.sagemaker#ModelName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services\n Region in an Amazon Web Services account.
The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.
The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.
The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.
Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" + "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job invocation.
" } }, "MaxPayloadInMB": { "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.
The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.
The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.
For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.
To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.
To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.
To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.
The environment variables to set in the Docker container. Don't include any\n sensitive data in your environment variables. We support up to 16 key and\n values entries in the map.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.
" } }, "TransformInput": { "target": "com.amazonaws.sagemaker#TransformInput", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the input source and\n the\n way the transform job consumes it.
", + "smithy.api#documentation": "Describes the input source and the way the transform job consumes it.
", "smithy.api#required": {} } }, @@ -15320,20 +15292,20 @@ "target": "com.amazonaws.sagemaker#TransformResources", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.
", + "smithy.api#documentation": "Describes the resources, including ML instance types and ML instance count, to use for the transform job.
", "smithy.api#required": {} } }, "DataProcessing": { "target": "com.amazonaws.sagemaker#DataProcessing", "traits": { - "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" + "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } }, "ExperimentConfig": { @@ -15377,7 +15349,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial and then use the Search API to search for\n the tags.
\nTo get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.
" + "smithy.api#documentation": "Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
" } }, "com.amazonaws.sagemaker#CreateTrialComponent": { @@ -15394,7 +15366,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.
\nTrial components include pre-processing jobs, training jobs, and batch transform\n jobs.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to a trial component and then use the Search API to\n search for the tags.
" + "smithy.api#documentation": "Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
" } }, "com.amazonaws.sagemaker#CreateTrialComponentRequest": { @@ -15404,20 +15376,20 @@ "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the component. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#documentation": "The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nThe status of the component. States include:
InProgress
Completed
Failed
The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.
" + "smithy.api#documentation": "The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
" } }, "OutputArtifacts": { "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "The output artifacts for the component. Examples of output artifacts are metrics,\n snapshots, logs, and images.
" + "smithy.api#documentation": "The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
" } }, "MetadataProperties": { @@ -15456,7 +15428,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of tags to associate with the component. You can use Search API\n to search on the tags.
" + "smithy.api#documentation": "A list of tags to associate with the component. You can use Search API to search on the tags.
" } } }, @@ -15485,14 +15457,14 @@ "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the trial. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.
", + "smithy.api#documentation": "The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.
", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
A list of tags to associate with the trial. You can use Search API to\n search on the tags.
" + "smithy.api#documentation": "A list of tags to associate with the trial. You can use Search API to search on the tags.
" } } }, @@ -15548,7 +15520,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user\n profile is automatically created. A user profile is the primary holder of settings for an\n individual user and has a reference to the user's private Amazon Elastic File System home\n directory.
" + "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.
" } }, "com.amazonaws.sagemaker#CreateUserProfileRequest": { @@ -15573,19 +15545,19 @@ "SingleSignOnUserIdentifier": { "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", "traits": { - "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only\n supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is\n required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" + "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" } }, "SingleSignOnUserValue": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this\n UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must\n match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" + "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
\nTags that you specify for the User Profile are also added to all Apps that the User\n Profile launches.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.
" } }, "UserSettings": { @@ -15622,7 +15594,7 @@ "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" }, "traits": { - "smithy.api#documentation": "Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.
\nIf you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the DeleteWorkforce API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).
Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
\nDo not use OidcConfig if you specify values for \n CognitoConfig.
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use OidcConfig if you specify values for CognitoConfig.
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
\nDo not use CognitoConfig if you specify values for \n OidcConfig.
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use CognitoConfig if you specify values for OidcConfig.
An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.
" + "smithy.api#documentation": "An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
" } }, "WorkforceVpcConfig": { @@ -15701,7 +15673,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.
\nYou cannot create more than 25 work teams in an account and region.
" + "smithy.api#documentation": "Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.
You cannot create more than 25 work teams in an account and region.
" } }, "com.amazonaws.sagemaker#CreateWorkteamRequest": { @@ -15725,7 +15697,7 @@ "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.
A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.
An array of key-value pairs.
\nFor more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.
" + "smithy.api#documentation": "An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, @@ -15766,7 +15738,7 @@ "WorkteamArn": { "target": "com.amazonaws.sagemaker#WorkteamArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the\n work team.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
" } } }, @@ -15845,7 +15817,7 @@ } }, "traits": { - "smithy.api#documentation": "A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" + "smithy.api#documentation": "A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" } }, "com.amazonaws.sagemaker#CustomFileSystemConfig": { @@ -15865,7 +15837,7 @@ } }, "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI\n Studio.
" + "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" } }, "com.amazonaws.sagemaker#CustomFileSystemConfigs": { @@ -15919,7 +15891,7 @@ } }, "traits": { - "smithy.api#documentation": "A custom SageMaker AI image. For more information, see\n Bring your own SageMaker AI image.
" + "smithy.api#documentation": "A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.
" } }, "com.amazonaws.sagemaker#CustomImageContainerArguments": { @@ -16077,7 +16049,7 @@ "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The percentage of requests SageMaker AI will capture. A lower value is recommended\n for Endpoints with high traffic.
", + "smithy.api#documentation": "The percentage of requests SageMaker AI will capture. A lower value is recommended for Endpoints with high traffic.
", "smithy.api#required": {} } }, @@ -16092,21 +16064,21 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI\n uses to encrypt the captured data at rest using Amazon S3 server-side\n encryption.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
Specifies data Model Monitor will capture. You can configure whether to collect only\n input, only output, or both
", + "smithy.api#documentation": "Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both
", "smithy.api#required": {} } }, "CaptureContentTypeHeader": { "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", "traits": { - "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified\n SageMaker AI will by default base64 encode when capturing the data.
" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified SageMaker AI will by default base64 encode when capturing the data.
" } } }, @@ -16191,7 +16163,7 @@ } }, "traits": { - "smithy.api#documentation": "The meta data of the Glue table which serves as data catalog for the\n OfflineStore.
The meta data of the Glue table which serves as data catalog for the OfflineStore.
A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.
Examples: \"$\", \"$[1:]\", \"$.features\"\n
A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.
Examples: \"$\", \"$[1:]\", \"$.features\"
A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.
Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n
A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.
Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"
Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.
\nFor information on how joining in applied, see Workflow for Associating Inferences with Input Records.
" + "smithy.api#documentation": "Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.
For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.
For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.
For information on how joining in applied, see Workflow for Associating Inferences with Input Records.
" } } }, "traits": { - "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.
" + "smithy.api#documentation": "The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
" } }, "com.amazonaws.sagemaker#DataQualityAppSpecification": { @@ -16281,13 +16253,13 @@ "RecordPreprocessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" } }, "Environment": { @@ -16318,7 +16290,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" } }, "com.amazonaws.sagemaker#DataQualityJobInput": { @@ -16335,7 +16307,7 @@ } }, "traits": { - "smithy.api#documentation": "The input for the data quality monitoring job. Currently endpoints are supported for\n input.
" + "smithy.api#documentation": "The input for the data quality monitoring job. Currently endpoints are supported for input.
" } }, "com.amazonaws.sagemaker#DataSource": { @@ -16397,24 +16369,24 @@ "LocalPath": { "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a\n processing job. LocalPath is an absolute path to the input data. This is a\n required parameter when AppManaged is False (default).
The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).
Whether the generated dataset is FullyReplicated or\n ShardedByS3Key (default).
Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
Whether to use File or Pipe input mode. In File\n (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic\n Block Store (Amazon EBS) volumes before starting your training algorithm. This is the\n most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from\n the source directly to your algorithm without using the EBS volume.
Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
Configuration for Dataset Definition inputs. The Dataset Definition input must specify\n exactly one of either AthenaDatasetDefinition or\n RedshiftDatasetDefinition types.
Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.
Path to local storage location for metrics and tensors. Defaults to\n /opt/ml/output/tensors/.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about\n how to configure the CollectionConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and\n storage paths. To learn more about\n how to configure the DebugHookConfig parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule\n configuration names.
", + "smithy.api#documentation": "The name of the rule configuration. It must be unique relative to other rule configuration names.
", "smithy.api#required": {} } }, "LocalPath": { "target": "com.amazonaws.sagemaker#DirectoryPath", "traits": { - "smithy.api#documentation": "Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Configuration information for SageMaker Debugger rules for debugging. To learn more about\n how to configure the DebugRuleConfiguration parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The security group IDs for the Amazon VPC that the space uses for\n communication.
" + "smithy.api#documentation": "The security group IDs for the Amazon VPC that the space uses for communication.
" } }, "JupyterServerAppSettings": { @@ -16650,12 +16622,12 @@ "CustomFileSystemConfigs": { "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access\n this file system in Amazon SageMaker AI Studio.
" + "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" } } }, "traits": { - "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\n spaces.
" + "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
" } }, "com.amazonaws.sagemaker#DefaultSpaceStorageSettings": { @@ -16828,13 +16800,13 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The user profile name. If this value is not set, then SpaceName must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be set.
Deletes an artifact. Either ArtifactArn or Source must be\n specified.
Deletes an artifact. Either ArtifactArn or Source must be specified.
Deletes the specified compilation job. This action deletes only the compilation job\n resource in Amazon SageMaker AI. It doesn't delete other resources that are related to\n that job, such as the model artifacts that the job creates, the compilation logs in\n CloudWatch, the compiled model, or the IAM role.
\nYou can delete a compilation job only if its current status is COMPLETED,\n FAILED, or STOPPED. If the job status is\n STARTING or INPROGRESS, stop the job, and then delete it\n after its status becomes STOPPED.
Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.
You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.
Used to delete a domain. If you onboarded with IAM mode, you will need to delete your\n domain to onboard again using IAM Identity Center. Use with caution. All of the members of the\n domain will lose access to their EFS volume, including data, notebooks, and other artifacts.\n
" + "smithy.api#documentation": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
" } }, "com.amazonaws.sagemaker#DeleteDomainRequest": { @@ -17296,7 +17268,7 @@ "RetentionPolicy": { "target": "com.amazonaws.sagemaker#RetentionPolicy", "traits": { - "smithy.api#documentation": "The retention policy for this domain, which specifies whether resources will be retained\n after the Domain is deleted. By default, all resources are retained (not automatically\n deleted).
" + "smithy.api#documentation": "The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).
" } } }, @@ -17318,7 +17290,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an edge deployment plan if (and only if) all the stages in the plan are\n inactive or there are no stages in the plan.
" + "smithy.api#documentation": "Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.
" } }, "com.amazonaws.sagemaker#DeleteEdgeDeploymentPlanRequest": { @@ -17351,7 +17323,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a stage in an edge deployment plan if (and only if) the stage is\n inactive.
" + "smithy.api#documentation": "Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
" } }, "com.amazonaws.sagemaker#DeleteEdgeDeploymentStageRequest": { @@ -17387,7 +17359,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.
\nSageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.
\nWhen you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.
Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.
SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.
Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.
Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Deletes an SageMaker experiment. All trials associated with the experiment must be deleted\n first. Use the ListTrials API to get a list of the trials associated with\n the experiment.
" + "smithy.api#documentation": "Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
" } }, "com.amazonaws.sagemaker#DeleteExperimentRequest": { @@ -17495,7 +17467,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.
Note that it can take approximately 10-15 minutes to delete an OnlineStore\n FeatureGroup with the InMemory\n StorageType.
Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.
Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.
The name of the FeatureGroup you want to delete. The name must be unique\n within an Amazon Web Services Region in an Amazon Web Services account.
The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
Use this operation to delete a human task user interface (worker task template).
\n\n To see a list of human task user interfaces\n (work task templates) in your account, use ListHumanTaskUis.\n When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.
Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.
Deletes a SageMaker AI image and all versions of the image. The container images aren't\n deleted.
" + "smithy.api#documentation": "Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.
" } }, "com.amazonaws.sagemaker#DeleteImageRequest": { @@ -17830,7 +17802,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a version of a SageMaker AI image. The container image the version represents isn't\n deleted.
" + "smithy.api#documentation": "Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.
" } }, "com.amazonaws.sagemaker#DeleteImageVersionRequest": { @@ -17913,7 +17885,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an inference experiment.
\n\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n
\nDeletes an inference experiment.
This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.
A TrackingServerArn object, the ARN of the tracking server that is deleted if\n successfully found.
A TrackingServerArn object, the ARN of the tracking server that is deleted if successfully found.
Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not delete\n model artifacts, inference code, or the IAM role that you specified when creating the\n model.
Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Deletes a model package.
\nA model package is used to create SageMaker models or list on Amazon Web Services\n Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace to create models in SageMaker.
" + "smithy.api#documentation": "Deletes a model package.
A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
" } }, "com.amazonaws.sagemaker#DeleteModelPackageGroup": { @@ -18210,7 +18182,7 @@ "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid characters are\n a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } } @@ -18266,7 +18238,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped.\n This does not delete the job execution history of the monitoring schedule.
" + "smithy.api#documentation": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
" } }, "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest": { @@ -18294,7 +18266,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": " Deletes an SageMaker AI notebook instance. Before you can delete a notebook\n instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the\n network interface associated with the notebook instance.
\n Deletes an SageMaker AI notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Deletes a pipeline if there are no running instances of the pipeline. To delete a\n pipeline, you must stop all running instances of the pipeline using the\n StopPipelineExecution API. When you delete a pipeline, all instances of the\n pipeline are deleted.
Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -18584,7 +18556,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the\n Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You\n must also remove the Lifecycle Configuration from UserSettings in all Domains and\n UserProfiles.
" + "smithy.api#documentation": "Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.
" } }, "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { @@ -18612,7 +18584,7 @@ "target": "com.amazonaws.sagemaker#DeleteTagsOutput" }, "traits": { - "smithy.api#documentation": "Deletes the specified tags from an SageMaker resource.
\nTo list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.
\nWhen you call this API to delete tags from a SageMaker Domain or User Profile, the\n deleted tags are not removed from Apps that the SageMaker Domain or User Profile\n launched before you called this API.
\nDeletes the specified tags from an SageMaker resource.
To list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.
When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.
The Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
", "smithy.api#required": {} } }, @@ -18660,7 +18632,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified trial. All trial components that make up the trial must be deleted\n first. Use the DescribeTrialComponent API to get the list of trial\n components.
" + "smithy.api#documentation": "Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
" } }, "com.amazonaws.sagemaker#DeleteTrialComponent": { @@ -18677,7 +18649,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified trial component. A trial component must be disassociated from all\n trials before the trial component can be deleted. To disassociate a trial component from a\n trial, call the DisassociateTrialComponent API.
" + "smithy.api#documentation": "Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
" } }, "com.amazonaws.sagemaker#DeleteTrialComponentRequest": { @@ -18757,7 +18729,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.
" + "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
" } }, "com.amazonaws.sagemaker#DeleteUserProfileRequest": { @@ -18793,7 +18765,7 @@ "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" }, "traits": { - "smithy.api#documentation": "Use this operation to delete a workforce.
\nIf you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use CreateWorkforce\n to create a new workforce.
\nIf a private workforce contains one or more work teams, you must use \n the DeleteWorkteam\n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will receive a ResourceInUse error.
Use this operation to delete a workforce.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will receive a ResourceInUse error.
Returns true if the work team was successfully deleted; otherwise,\n returns false.
Returns true if the work team was successfully deleted; otherwise, returns false.
The specific digest path of the image hosted in this\n ProductionVariant.
The specific digest path of the image hosted in this ProductionVariant.
The date and time when the image path for the model resolved to the\n ResolvedImage\n
The date and time when the image path for the model resolved to the ResolvedImage
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
\nIf you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.
" + "smithy.api#documentation": "Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
" } }, "RollingUpdatePolicy": { @@ -18938,12 +18910,12 @@ "AutoRollbackConfiguration": { "target": "com.amazonaws.sagemaker#AutoRollbackConfig", "traits": { - "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and\n recovery.
" + "smithy.api#documentation": "Automatic rollback configuration for handling endpoint deployment failures and recovery.
" } } }, "traits": { - "smithy.api#documentation": "The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" + "smithy.api#documentation": "The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
" } }, "com.amazonaws.sagemaker#DeploymentConfiguration": { @@ -18979,7 +18951,7 @@ "target": "com.amazonaws.sagemaker#RecommendationStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker\n is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS,\n retry your API call after a few seconds to get a COMPLETED deployment recommendation.
Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.
A set of recommended deployment configurations for the model. To get more advanced recommendations, see\n CreateInferenceRecommendationsJob\n to create an inference recommendation job.
" + "smithy.api#documentation": "A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.
" } }, "com.amazonaws.sagemaker#DeploymentStage": { @@ -19126,7 +19098,7 @@ "DerivedDataInputConfig": { "target": "com.amazonaws.sagemaker#DataInputConfig", "traits": { - "smithy.api#documentation": "The data input configuration that SageMaker Neo automatically derived for the model.\n When SageMaker Neo derives this information, you don't need to specify the data input\n configuration when you create a compilation job.
" + "smithy.api#documentation": "The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don't need to specify the data input configuration when you create a compilation job.
" } } }, @@ -19322,7 +19294,7 @@ "ValidationSpecification": { "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", "traits": { - "smithy.api#documentation": "Details about configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" + "smithy.api#documentation": "Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
" } }, "AlgorithmStatus": { @@ -19350,7 +19322,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "Whether the algorithm is certified to be listed in Amazon Web Services\n Marketplace.
" + "smithy.api#documentation": "Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
" } } }, @@ -19472,7 +19444,7 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be\n set.
The user profile name. If this value is not set, then SpaceName must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The name of the space. If this value is not set, then UserProfileName must be set.
\n Indicates whether the application is launched in recovery mode.\n
" + "smithy.api#documentation": "Indicates whether the application is launched in recovery mode.
" } }, "LastHealthCheckTimestamp": { @@ -19562,13 +19534,13 @@ "LastUserActivityTimestamp": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp of the last user's activity. LastUserActivityTimestamp is also\n updated when SageMaker AI performs health checks without user activity. As a result, this\n value is set to the same value as LastHealthCheckTimestamp.
The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
The creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker AI deletes all\n metadata for the application. To be considered an update and retain application metadata,\n applications must be restarted within 24 hours after the previous application has been shut\n down. After this time window, creation of an application is considered a new application\n rather than an update of the previous application.
\nThe creation time of the application.
After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image\n created on the instance.
" + "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
" } }, "BuiltInLifecycleConfigArn": { @@ -19706,7 +19678,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJob.
\nAutoML jobs created by calling CreateAutoMLJobV2 cannot be described by\n DescribeAutoMLJob.
Returns information about an AutoML job created by calling CreateAutoMLJob.
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.
The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", + "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -19823,7 +19795,7 @@ "BestCandidate": { "target": "com.amazonaws.sagemaker#AutoMLCandidate", "traits": { - "smithy.api#documentation": "The best model candidate selected by SageMaker AI Autopilot using both the best\n objective metric and lowest InferenceLatency for\n an experiment.
" + "smithy.api#documentation": "The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
" } }, "AutoMLJobStatus": { @@ -19845,25 +19817,25 @@ "GenerateCandidateDefinitionsOnly": { "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", "traits": { - "smithy.api#documentation": "Indicates whether the output for an AutoML job generates candidate definitions\n only.
" + "smithy.api#documentation": "Indicates whether the output for an AutoML job generates candidate definitions only.
" } }, "AutoMLJobArtifacts": { "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", "traits": { - "smithy.api#documentation": "Returns information on the job's artifacts found in\n AutoMLJobArtifacts.
Returns information on the job's artifacts found in AutoMLJobArtifacts.
Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n inferred.
Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.
Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" + "smithy.api#documentation": "Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
" } }, "ModelDeployResult": { @@ -19891,7 +19863,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJobV2\n or CreateAutoMLJob.
" + "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
" } }, "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request": { @@ -19949,7 +19921,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.
", + "smithy.api#documentation": "The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -20008,7 +19980,7 @@ "BestCandidate": { "target": "com.amazonaws.sagemaker#AutoMLCandidate", "traits": { - "smithy.api#documentation": "Information about the candidate produced by an AutoML training job V2, including its\n status, steps, and other properties.
" + "smithy.api#documentation": "Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
" } }, "AutoMLJobStatus": { @@ -20039,7 +20011,7 @@ "ModelDeployConfig": { "target": "com.amazonaws.sagemaker#ModelDeployConfig", "traits": { - "smithy.api#documentation": "Indicates whether the model was deployed automatically to an endpoint and the name of\n that endpoint if deployed automatically.
" + "smithy.api#documentation": "Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
" } }, "ModelDeployResult": { @@ -20051,13 +20023,13 @@ "DataSplitConfig": { "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", "traits": { - "smithy.api#documentation": "Returns the configuration settings of how the data are split into train and validation\n datasets.
" + "smithy.api#documentation": "Returns the configuration settings of how the data are split into train and validation datasets.
" } }, "SecurityConfig": { "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", "traits": { - "smithy.api#documentation": "Returns the security configuration for traffic encryption or Amazon VPC\n settings.
" + "smithy.api#documentation": "Returns the security configuration for traffic encryption or Amazon VPC settings.
" } }, "AutoMLComputeConfig": { @@ -20102,7 +20074,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information of a node (also called a instance\n interchangeably) of a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { @@ -20240,7 +20212,7 @@ } ], "traits": { - "smithy.api#documentation": "Description of the cluster policy. This policy is used for task prioritization and\n fair-share allocation. This helps prioritize critical workloads and distributes\n idle compute across entities.
" + "smithy.api#documentation": "Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
" } }, "com.amazonaws.sagemaker#DescribeClusterSchedulerConfigRequest": { @@ -20323,7 +20295,7 @@ "SchedulerConfig": { "target": "com.amazonaws.sagemaker#SchedulerConfig", "traits": { - "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
" } }, "Description": { @@ -20423,7 +20395,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the\n repository.
" + "smithy.api#documentation": "Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.
" } } }, @@ -20445,7 +20417,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a model compilation job.
\nTo create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation\n jobs, use ListCompilationJobs.
" + "smithy.api#documentation": "Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
" } }, "com.amazonaws.sagemaker#DescribeCompilationJobRequest": { @@ -20494,33 +20466,33 @@ "CompilationStartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The time when the model compilation job started the CompilationJob\n instances.
You are billed for the time between this timestamp and the timestamp in the\n CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later\n than this time. That's because it takes time to download the compilation job, which\n depends on the size of the compilation job container.
The time when the model compilation job started the CompilationJob instances.
You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.
The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.
" + "smithy.api#documentation": "The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.
" } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches\n the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training\n costs.
", + "smithy.api#documentation": "Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.
", "smithy.api#required": {} } }, "InferenceImage": { "target": "com.amazonaws.sagemaker#InferenceImage", "traits": { - "smithy.api#documentation": "The inference image to use when compiling a model. Specify an image only if the target\n device is a cloud instance.
" + "smithy.api#documentation": "The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
" } }, "ModelPackageVersionArn": { "target": "com.amazonaws.sagemaker#ModelPackageArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the versioned model package that was \n provided to SageMaker Neo when you initiated a compilation job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
" } }, "CreationTime": { @@ -20535,7 +20507,7 @@ "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time that the status\n of\n the model compilation job was last modified.
", + "smithy.api#documentation": "The time that the status of the model compilation job was last modified.
", "smithy.api#required": {} } }, @@ -20551,21 +20523,21 @@ "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the location in Amazon S3 that has been configured for storing the model\n artifacts used in the compilation job.
", + "smithy.api#documentation": "Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
", "smithy.api#required": {} } }, "ModelDigests": { "target": "com.amazonaws.sagemaker#ModelDigests", "traits": { - "smithy.api#documentation": "Provides a BLAKE2 hash value that identifies the compiled model artifacts in\n Amazon S3.
" + "smithy.api#documentation": "Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
" } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model\n compilation job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.
", "smithy.api#required": {} } }, @@ -20573,7 +20545,7 @@ "target": "com.amazonaws.sagemaker#InputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the location in Amazon S3 of the input model artifacts, the name and\n shape of the expected data inputs, and the framework in which the model was\n trained.
", + "smithy.api#documentation": "Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
", "smithy.api#required": {} } }, @@ -20581,14 +20553,14 @@ "target": "com.amazonaws.sagemaker#OutputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the output location for the compiled model and the target device\n that the model runs on.
", + "smithy.api#documentation": "Information about the output location for the compiled model and the target device that the model runs on.
", "smithy.api#required": {} } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#NeoVpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job\n to connect to. Control access to your models by configuring the VPC. For more\n information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
" } }, "DerivedInformation": { @@ -20705,7 +20677,7 @@ "ComputeQuotaConfig": { "target": "com.amazonaws.sagemaker#ComputeQuotaConfig", "traits": { - "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
" } }, "ComputeQuotaTarget": { @@ -20719,7 +20691,7 @@ "ActivationState": { "target": "com.amazonaws.sagemaker#ActivationState", "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is Enabled.
The list of inputs for the data quality monitoring job. Currently endpoints are\n supported.
", + "smithy.api#documentation": "The list of inputs for the data quality monitoring job. Currently endpoints are supported.
", "smithy.api#required": {} } }, @@ -20954,7 +20926,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -21261,7 +21233,7 @@ "SingleSignOnApplicationArn": { "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the application managed by SageMaker AI in IAM Identity Center. This value\n is only returned for domains created after October 1, 2023.
" + "smithy.api#documentation": "The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
" } }, "Status": { @@ -21291,7 +21263,7 @@ "SecurityGroupIdForDomainBoundary": { "target": "com.amazonaws.sagemaker#SecurityGroupId", "traits": { - "smithy.api#documentation": "The ID of the security group that authorizes traffic between the\n RSessionGateway apps and the RStudioServerPro app.
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
Settings which are applied to UserProfiles in this domain if settings are not explicitly\n specified in a given UserProfile.
" + "smithy.api#documentation": "Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
" } }, "DomainSettings": { @@ -21315,7 +21287,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access
VpcOnly - All traffic is through the specified VPC and subnets
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to\n the domain.
" + "smithy.api#documentation": "The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
" } }, "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
If the edge deployment plan has enough stages to require tokening, then this is the\n response from the last list of stages returned.
" + "smithy.api#documentation": "If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.
" } }, "MaxResults": { @@ -21576,7 +21548,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
" } }, "OutputConfig": { @@ -21673,7 +21645,8 @@ } } ], - "minDelay": 30 + "minDelay": 30, + "maxDelay": 1800 }, "EndpointInService": { "acceptors": [ @@ -21704,7 +21677,8 @@ } } ], - "minDelay": 30 + "minDelay": 30, + "maxDelay": 3600 } } } @@ -21718,7 +21692,7 @@ "target": "com.amazonaws.sagemaker#DescribeEndpointConfigOutput" }, "traits": { - "smithy.api#documentation": "Returns the description of an endpoint configuration created using the\n CreateEndpointConfig API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML\n storage volume attached to the instance.
" + "smithy.api#documentation": "Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
" } }, "CreationTime": { @@ -21784,7 +21758,7 @@ "AsyncInferenceConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", "traits": { - "smithy.api#documentation": "Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.
An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.
The Amazon Resource Name (ARN) of the IAM role that you assigned to the\n endpoint configuration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
" } }, "VpcConfig": { @@ -21811,7 +21785,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether all model containers deployed to the endpoint are isolated. If they\n are, no inbound or outbound network calls can be made to or from the model\n containers.
" + "smithy.api#documentation": "Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
" } } }, @@ -21863,7 +21837,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model hosted behind this\n endpoint.
" + "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
" } }, "DataCaptureConfig": { @@ -21873,14 +21847,14 @@ "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
\n UpdateRollbackFailed: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to InService, see Rolling\n Deployments.
The status of the endpoint.
OutOfService: Endpoint is not available to take incoming requests.
Creating: CreateEndpoint is executing.
Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.
RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
InService: Endpoint is available to process incoming requests.
Deleting: DeleteEndpoint is executing.
Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.
If the status of the endpoint is Failed, the reason why it failed.\n
If the status of the endpoint is Failed, the reason why it failed.
Returns the description of an endpoint configuration created using the \n CreateEndpointConfig\n API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Returns the summary of an in-progress deployment. This field is only returned when the\n endpoint is creating or updating with a new endpoint configuration.
" + "smithy.api#documentation": "Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
" } }, "ExplainerConfig": { @@ -21926,7 +21900,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model that you want to host\n at this endpoint in shadow mode with production traffic replicated from the model\n specified on ProductionVariants.
An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.
The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
Use this operation to describe a FeatureGroup. The response includes\n information on the creation time, FeatureGroup name, the unique identifier for\n each FeatureGroup, and more.
Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want\n described.
The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
A token to resume pagination of the list of Features\n (FeatureDefinitions). 2,500 Features are returned by\n default.
A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.
The name of the Feature used for RecordIdentifier, whose value\n uniquely identifies a record stored in the feature store.
The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds\n to the creation or update of a Record in a FeatureGroup. All\n Records in the FeatureGroup have a corresponding\n EventTime.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.
A list of the Features in the FeatureGroup. Each feature is\n defined by a FeatureName and FeatureType.
A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
The configuration of the offline store. It includes the following configurations:
\nAmazon S3 location of the offline store.
\nConfiguration of the Glue data catalog.
\nTable format of the offline store.
\nOption to disable the automatic creation of a Glue table for the offline\n store.
\nEncryption configuration.
\nThe configuration of the offline store. It includes the following configurations:
Amazon S3 location of the offline store.
Configuration of the Glue data catalog.
Table format of the offline store.
Option to disable the automatic creation of a Glue table for the offline store.
Encryption configuration.
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
" } }, "FeatureGroupStatus": { @@ -22155,7 +22129,7 @@ "OfflineStoreStatus": { "target": "com.amazonaws.sagemaker#OfflineStoreStatus", "traits": { - "smithy.api#documentation": "The status of the OfflineStore. Notifies you if replicating data into the\n OfflineStore has failed. Returns either: Active or\n Blocked\n
The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the\n OfflineStore.
The FeatureGroup could not be deleted from the\n OfflineStore.
The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the OfflineStore.
The FeatureGroup could not be deleted from the OfflineStore.
A token to resume pagination of the list of Features\n (FeatureDefinitions).
A token to resume pagination of the list of Features (FeatureDefinitions).
The name or Amazon Resource Name (ARN) of the feature group containing the\n feature.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature.
", "smithy.api#required": {} } }, @@ -22283,7 +22257,7 @@ "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp indicating when the metadata for the feature group was modified. For\n example, if you add a parameter describing the feature, the timestamp changes to reflect\n the last time you
", + "smithy.api#documentation": "A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you
", "smithy.api#required": {} } }, @@ -22375,7 +22349,7 @@ "HumanLoopRequestSource": { "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", "traits": { - "smithy.api#documentation": "Container for configuring the source of human task requests. Used to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.
" + "smithy.api#documentation": "Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" } }, "HumanLoopActivationConfig": { @@ -22755,7 +22729,7 @@ "target": "com.amazonaws.sagemaker#HumanTaskUiName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the human task user interface \n (worker task template) you want information about.
", + "smithy.api#documentation": "The name of the human task user interface (worker task template) you want information about.
", "smithy.api#required": {} } } @@ -22823,7 +22797,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a description of a hyperparameter tuning job, depending on the fields\n selected. These fields can include the name, Amazon Resource Name (ARN), job status of\n your tuning job and more.
" + "smithy.api#documentation": "Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.
" } }, "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobRequest": { @@ -22865,20 +22839,20 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterTuningJobConfig object that specifies the configuration of\n the tuning job.
", + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
", "smithy.api#required": {} } }, "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the definition of\n the training jobs that this tuning job launches.
" + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
" } }, "TrainingJobDefinitions": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
" } }, "HyperParameterTuningJobStatus": { @@ -22913,7 +22887,7 @@ "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of training\n jobs, categorized by status, that this tuning job launched.
", + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
", "smithy.api#required": {} } }, @@ -22921,26 +22895,26 @@ "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of training jobs,\n categorized by the status of their final objective metric, that this tuning job\n launched.
", + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
", "smithy.api#required": {} } }, "BestTrainingJob": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that completed\n with the best current HyperParameterTuningJobObjective.
" + "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
" } }, "OverallBestTrainingJob": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective metric\n value of all training jobs launched by this tuning job and all parent jobs specified for\n the warm start tuning job.
If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
The configuration for starting the hyperparameter parameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.
" + "smithy.api#documentation": "The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
" } }, "Autotune": { @@ -22958,7 +22932,7 @@ "TuningJobCompletionDetails": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobCompletionDetails", "traits": { - "smithy.api#documentation": "Tuning job completion information returned as the response from a hyperparameter\n tuning job. This information tells if your tuning job has or has not converged. It also\n includes the number of training jobs that have not improved model performance as\n evaluated against the objective function.
" + "smithy.api#documentation": "Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.
" } }, "ConsumedResources": { @@ -23017,7 +22991,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 }, "ImageDeleted": { "acceptors": [ @@ -23044,7 +23019,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 }, "ImageUpdated": { "acceptors": [ @@ -23075,7 +23051,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 } } } @@ -23206,7 +23183,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 }, "ImageVersionDeleted": { "acceptors": [ @@ -23233,7 +23211,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 } } } @@ -23326,13 +23305,13 @@ "VendorGuidance": { "target": "com.amazonaws.sagemaker#VendorGuidance", "traits": { - "smithy.api#documentation": "The stability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
The stability of the image version specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable.
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates SageMaker AI job type compatibility.
TRAINING: The image version is compatible with SageMaker AI training jobs.
INFERENCE: The image version is compatible with SageMaker AI inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
If the inference component status is Failed, the reason for the\n failure.
If the inference component status is Failed, the reason for the failure.
Details about the runtime settings for the model that is deployed with the inference\n component.
" + "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference component.
" } }, "CreationTime": { @@ -23482,7 +23461,7 @@ "LastDeploymentConfig": { "target": "com.amazonaws.sagemaker#InferenceComponentDeploymentConfig", "traits": { - "smithy.api#documentation": "The deployment and rollback settings that you assigned to the inference\n component.
" + "smithy.api#documentation": "The deployment and rollback settings that you assigned to the inference component.
" } } }, @@ -23560,14 +23539,14 @@ "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n
\n\n Creating - Amazon SageMaker is creating your experiment.\n
\n Created - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n
\n Updating - When you make changes to your experiment, your experiment shows as updating.\n
\n Starting - Amazon SageMaker is beginning your experiment.\n
\n Running - Your experiment is in progress.\n
\n Stopping - Amazon SageMaker is stopping your experiment.\n
\n Completed - Your experiment has completed.\n
\n Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n
The status of the inference experiment. The following are the possible statuses for an inference experiment:
Creating - Amazon SageMaker is creating your experiment.
Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
Updating - When you make changes to your experiment, your experiment shows as updating.
Starting - Amazon SageMaker is beginning your experiment.
Running - Your experiment is in progress.
Stopping - Amazon SageMaker is stopping your experiment.
Completed - Your experiment has completed.
Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.
\n The error message or client-specified Reason from the StopInferenceExperiment\n API, that explains the status of the inference experiment.\n
The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
\n The timestamp at which the inference experiment was completed.\n
" + "smithy.api#documentation": "The timestamp at which the inference experiment was completed.
" } }, "LastModifiedTime": { @@ -23597,7 +23576,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" + "smithy.api#documentation": "The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
" } }, "EndpointMetadata": { @@ -23612,7 +23591,7 @@ "target": "com.amazonaws.sagemaker#ModelVariantConfigSummaryList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n An array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n
An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.
\n The configuration of ShadowMode inference experiment type, which shows the production variant\n that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n
The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see\n CreateInferenceExperiment.\n
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
" } } }, @@ -23653,7 +23632,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides the results of the Inference Recommender job. \n One or more recommendation jobs are returned.
" + "smithy.api#documentation": "Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
" } }, "com.amazonaws.sagemaker#DescribeInferenceRecommendationsJobRequest": { @@ -23663,7 +23642,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } } @@ -23679,7 +23658,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job. The name must be unique within an \n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -23709,7 +23688,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services \n Identity and Access Management (IAM) role you provided when you initiated the job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
", "smithy.api#required": {} } }, @@ -23753,7 +23732,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobInputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Returns information about the versioned model package Amazon Resource Name (ARN), \n the traffic pattern, and endpoint configurations you provided when you initiated the job.
", + "smithy.api#documentation": "Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
", "smithy.api#required": {} } }, @@ -23828,7 +23807,7 @@ "target": "com.amazonaws.sagemaker#LabelCounters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.
", + "smithy.api#documentation": "Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.
", "smithy.api#required": {} } }, @@ -23888,7 +23867,7 @@ "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.
", + "smithy.api#documentation": "Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
", "smithy.api#required": {} } }, @@ -23896,7 +23875,7 @@ "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location of the job's output data and the Amazon Web Services Key Management\n Service key ID for the key used to encrypt the output data, if any.
", + "smithy.api#documentation": "The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
", "smithy.api#required": {} } }, @@ -23904,20 +23883,20 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf\n during data labeling.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
", "smithy.api#required": {} } }, "LabelCategoryConfigS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:
\nSemantic segmentation labeling jobs using automated labeling: 20 labels
\nBox bounding labeling jobs (all): 10 labels
\nThe file is a JSON structure in the following format:
\n\n {\n
\n \"document-version\": \"2018-11-28\"\n
\n \"labels\": [\n
\n {\n
\n \"label\": \"label 1\"\n
\n },\n
\n {\n
\n \"label\": \"label 2\"\n
\n },\n
\n ...\n
\n {\n
\n \"label\": \"label n\"\n
\n }\n
\n ]\n
\n }\n
The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:
Semantic segmentation labeling jobs using automated labeling: 20 labels
Box bounding labeling jobs (all): 10 labels
The file is a JSON structure in the following format:
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label 1\"
},
{
\"label\": \"label 2\"
},
...
{
\"label\": \"label n\"
}
]
}
A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.
" + "smithy.api#documentation": "A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
" } }, "LabelingJobAlgorithmsConfig": { @@ -23930,14 +23909,14 @@ "target": "com.amazonaws.sagemaker#HumanTaskConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Configuration information required for human workers to complete a labeling\n task.
", + "smithy.api#documentation": "Configuration information required for human workers to complete a labeling task.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } }, "LabelingJobOutput": { @@ -23965,7 +23944,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of properties for the requested lineage group. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#DescribeLineageGroupRequest": { @@ -24085,7 +24064,7 @@ "ArtifactStoreUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server\n artifact store.
" + "smithy.api#documentation": "The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.
" } }, "TrackingServerSize": { @@ -24103,7 +24082,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server\n uses to access the artifact store in Amazon S3.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3.
" } }, "TrackingServerStatus": { @@ -24168,7 +24147,7 @@ "target": "com.amazonaws.sagemaker#DescribeModelOutput" }, "traits": { - "smithy.api#documentation": "Describes a model that you created using the CreateModel\n API.
Describes a model that you created using the CreateModel API.
The name of the bias job definition. The name must be unique within an Amazon Web Services \n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -24277,7 +24256,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -24362,7 +24341,7 @@ "target": "com.amazonaws.sagemaker#ModelCardExportJobStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The completion status of the model card export job.
\n\n InProgress: The model card export job is in progress.
\n Completed: The model card export job is complete.
\n Failed: The model card export job failed. To see the reason for the failure, see\n the FailureReason field in the response to a\n DescribeModelCardExportJob call.
The completion status of the model card export job.
InProgress: The model card export job is in progress.
Completed: The model card export job is complete.
Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
\n DeletePending: Model card deletion request received.
\n DeleteInProgress: Model card deletion is in progress.
\n ContentDeleted: Deleted model card content.
\n ExportJobsDeleted: Deleted all export jobs associated with the model card.
\n DeleteCompleted: Successfully deleted the model card.
\n DeleteFailed: The model card failed to delete.
The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
DeletePending: Model card deletion request received.
DeleteInProgress: Model card deletion is in progress.
ContentDeleted: Deleted model card content.
ExportJobsDeleted: Deleted all export jobs associated with the model card.
DeleteCompleted: Successfully deleted the model card.
DeleteFailed: The model card failed to delete.
The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } } @@ -24635,7 +24614,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the \n input data location and write permission to the output data location in Amazon S3.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "smithy.api#required": {} } }, @@ -24677,7 +24656,7 @@ "PrimaryContainer": { "target": "com.amazonaws.sagemaker#ContainerDefinition", "traits": { - "smithy.api#documentation": "The location of the primary inference code, associated artifacts, and custom\n environment map that the inference code uses when it is deployed in production.\n
" + "smithy.api#documentation": "The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
" } }, "Containers": { @@ -24695,13 +24674,13 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
" } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this model has access to. For\n more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
" } }, "CreationTime": { @@ -24723,7 +24702,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "If True, no inbound or outbound network calls can be made to or from the\n model container.
If True, no inbound or outbound network calls can be made to or from the model container.
Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.
\nIf you provided a KMS Key ID when you created your model package,\n you will see the KMS Decrypt API call in\n your CloudTrail logs when you use this API.
\nTo create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#DescribeModelPackageGroup": { @@ -24837,7 +24816,7 @@ "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid characters are\n a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } } @@ -24860,7 +24839,7 @@ "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "If the model is a versioned model, the name of the model group that the versioned\n model belongs to.
" + "smithy.api#documentation": "If the model is a versioned model, the name of the model group that the versioned model belongs to.
" } }, "ModelPackageVersion": { @@ -24894,7 +24873,7 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Details about inference jobs that you can run with models based on this model\n package.
" + "smithy.api#documentation": "Details about inference jobs that you can run with models based on this model package.
" } }, "SourceAlgorithmSpecification": { @@ -24906,7 +24885,7 @@ "ValidationSpecification": { "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", "traits": { - "smithy.api#documentation": "Configurations for one or more transform jobs that SageMaker runs to test the model\n package.
" + "smithy.api#documentation": "Configurations for one or more transform jobs that SageMaker runs to test the model package.
" } }, "ModelPackageStatus": { @@ -24928,7 +24907,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services\n Marketplace.
" + "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services Marketplace.
" } }, "ModelApprovalStatus": { @@ -24967,19 +24946,19 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine\n learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes. Common\n machine learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a\n single gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).
" } }, "CustomerMetadataProperties": { @@ -24991,13 +24970,13 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker\n Pipelines in the Amazon SageMaker Developer Guide.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference\n Specification specifies artifacts based on this model package that can be used on\n inference endpoints. Generally used with SageMaker Neo to store the compiled\n artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" } }, "SkipModelValidation": { @@ -25015,13 +24994,13 @@ "SecurityConfig": { "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
The name of the model quality job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } } @@ -25141,7 +25120,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -25216,13 +25195,13 @@ "MonitoringType": { "target": "com.amazonaws.sagemaker#MonitoringType", "traits": { - "smithy.api#documentation": "The type of the monitoring job that this schedule runs. This is one of the following\n values.
\n\n DATA_QUALITY - The schedule is for a data quality monitoring\n job.
\n MODEL_QUALITY - The schedule is for a model quality monitoring\n job.
\n MODEL_BIAS - The schedule is for a bias monitoring job.
\n MODEL_EXPLAINABILITY - The schedule is for an explainability\n monitoring job.
The type of the monitoring job that this schedule runs. This is one of the following values.
DATA_QUALITY - The schedule is for a data quality monitoring job.
MODEL_QUALITY - The schedule is for a model quality monitoring job.
MODEL_BIAS - The schedule is for a bias monitoring job.
MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.
A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.
" + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
" } }, "CreationTime": { @@ -25245,7 +25224,7 @@ "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring job.
", "smithy.api#required": {} } }, @@ -25299,7 +25278,8 @@ } } ], - "minDelay": 30 + "minDelay": 30, + "maxDelay": 1800 }, "NotebookInstanceInService": { "acceptors": [ @@ -25324,7 +25304,8 @@ } } ], - "minDelay": 30 + "minDelay": 30, + "maxDelay": 1800 }, "NotebookInstanceStopped": { "acceptors": [ @@ -25349,7 +25330,8 @@ } } ], - "minDelay": 30 + "minDelay": 30, + "maxDelay": 1800 } } } @@ -25379,7 +25361,7 @@ "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput" }, "traits": { - "smithy.api#documentation": "Returns a description of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + "smithy.api#documentation": "Returns a description of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput": { @@ -25422,7 +25404,7 @@ "OnStart": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { - "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.
" + "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
" } }, "LastModifiedTime": { @@ -25472,7 +25454,7 @@ "Url": { "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", "traits": { - "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.
" + "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
" } }, "InstanceType": { @@ -25496,43 +25478,43 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.
" } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when\n storing it on the ML storage volume attached to the instance.
" + "smithy.api#documentation": "The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.
" } }, "NetworkInterfaceId": { "target": "com.amazonaws.sagemaker#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "The network interface IDs that SageMaker AI created at the time of creating\n the instance.
" + "smithy.api#documentation": "The network interface IDs that SageMaker AI created at the time of creating the instance.
" } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.
" + "smithy.api#documentation": "A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
" } }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A timestamp. Use this parameter to return the time when the notebook instance was\n created
" + "smithy.api#documentation": "A timestamp. Use this parameter to return the time when the notebook instance was created
" } }, "NotebookInstanceLifecycleConfigName": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "Returns the name of a notebook instance lifecycle configuration.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n
" + "smithy.api#documentation": "Returns the name of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance
" } }, "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "Describes whether SageMaker AI provides internet access to the notebook instance.\n If this value is set to Disabled, the notebook instance does not\n have internet access, and cannot connect to SageMaker AI training and endpoint\n services.
\nFor more information, see Notebook Instances Are Internet-Enabled by Default.
" + "smithy.api#documentation": "Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.
For more information, see Notebook Instances Are Internet-Enabled by Default.
" } }, "VolumeSizeInGB": { @@ -25544,25 +25526,25 @@ "AcceleratorTypes": { "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types associated with\n this notebook instance.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types associated with this notebook instance.
" } }, "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance.
\nLifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.
\nWhether root access is enabled or disabled for users of the notebook instance.
Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
If the optimization job status is FAILED, the reason for the\n failure.
If the optimization job status is FAILED, the reason for the failure.
The name of the processing job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } } @@ -26257,7 +26240,7 @@ "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.
", + "smithy.api#documentation": "The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -26265,7 +26248,7 @@ "target": "com.amazonaws.sagemaker#ProcessingResources", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
", + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
", "smithy.api#required": {} } }, @@ -26298,7 +26281,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" } }, "ExperimentConfig": { @@ -26326,13 +26309,13 @@ "ExitMessage": { "target": "com.amazonaws.sagemaker#ExitMessage", "traits": { - "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" + "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" } }, "ProcessingEndTime": { @@ -26364,7 +26347,7 @@ "MonitoringScheduleArn": { "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", "traits": { - "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" + "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing job.
" } }, "AutoMLJobArn": { @@ -26448,7 +26431,7 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.
" + "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.
" } }, "ServiceCatalogProvisionedProductDetails": { @@ -26609,7 +26592,7 @@ "Url": { "target": "com.amazonaws.sagemaker#String1024", "traits": { - "smithy.api#documentation": "Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity\n Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to\n the URL after appending the respective redirect parameter for the application type to be\n federated through Amazon Web Services IAM Identity Center.
\nThe following application types are supported:
\nStudio Classic: &redirect=JupyterServer\n
JupyterLab: &redirect=JupyterLab\n
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:\n &redirect=CodeEditor\n
Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.
The following application types are supported:
Studio Classic: &redirect=JupyterServer
JupyterLab: &redirect=JupyterLab
Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor
The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is\n described.
" + "smithy.api#documentation": "The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.
" } }, "CreationTime": { @@ -26674,7 +26657,7 @@ "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
" } }, "StudioLifecycleConfigContent": { @@ -26703,7 +26686,7 @@ "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse" }, "traits": { - "smithy.api#documentation": "Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest": { @@ -26752,7 +26735,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a training job.
\nSome of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.
Returns information about a training job.
Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
" } }, "LabelingJobArn": { "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the\n transform or training job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.
" } }, "AutoMLJobArn": { @@ -26858,7 +26842,7 @@ "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model artifacts.\n
", + "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model artifacts.
", "smithy.api#required": {} } }, @@ -26866,7 +26850,7 @@ "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the training job.
\nSageMaker provides the following training job statuses:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
The status of the training job.
SageMaker provides the following training job statuses:
InProgress - The training is in progress.
Completed - The training job has completed.
Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
Stopping - The training job is stopping.
Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Interrupted - The job stopped because the managed\n spot training instances were interrupted.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTraining\n
\n DownloadingTrainingImage\n
Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of them:
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Interrupted - The job stopped because the managed spot training instances were interrupted.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTraining
DownloadingTrainingImage
Information about the algorithm used for training, and algorithm metadata.\n
", + "smithy.api#documentation": "Information about the algorithm used for training, and algorithm metadata.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for\n the training job.
" + "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
" } }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "An array of Channel objects that describes each data input channel.\n
An array of Channel objects that describes each data input channel.
The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" + "smithy.api#documentation": "The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
" } }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.
", + "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are configured for model training.
", "smithy.api#required": {} } }, @@ -26933,14 +26917,14 @@ "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" + "smithy.api#documentation": "A timestamp that indicates when the status of the training job was last modified.
" } }, "SecondaryStatusTransitions": { "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", "traits": { - "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" + "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned through.
" } }, "FinalMetricDataList": { "target": "com.amazonaws.sagemaker#FinalMetricDataList", "traits": { - "smithy.api#documentation": "A collection of MetricData objects that specify the names, values, and\n dates and times that the training algorithm emitted to Amazon CloudWatch.
A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
A Boolean indicating whether managed spot training is enabled (True) or not (False).
The billable time in seconds. Billable time refers to the absolute wall-clock\n time.
\nMultiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.
The billable time in seconds. Billable time refers to the absolute wall-clock time.
Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .
You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.
Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
" } }, "ProfilerRuleEvaluationStatuses": { @@ -27060,19 +27044,19 @@ "Environment": { "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request environment variable or plain text fields.
\nThe environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The number of times to retry the job when the job fails due to an\n InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + "smithy.api#documentation": "Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
" } }, "InfraCheckConfig": { @@ -27142,14 +27126,14 @@ "target": "com.amazonaws.sagemaker#TrainingPlanStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
A message providing additional information about the current status of the training\n plan.
" + "smithy.api#documentation": "A message providing additional information about the current status of the training plan.
" } }, "DurationHours": { @@ -27161,7 +27145,7 @@ "DurationMinutes": { "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan.
" } }, "StartTime": { @@ -27209,13 +27193,13 @@ "TargetResources": { "target": "com.amazonaws.sagemaker#SageMakerResourceNames", "traits": { - "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
The list of Reserved Capacity providing the underlying compute resources of the plan.\n
" + "smithy.api#documentation": "The list of Reserved Capacity providing the underlying compute resources of the plan.
" } } }, @@ -27281,7 +27265,8 @@ } } ], - "minDelay": 60 + "minDelay": 60, + "maxDelay": 3600 } } } @@ -27325,14 +27310,14 @@ "target": "com.amazonaws.sagemaker#TransformJobStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.
The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.
If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.
The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.
" + "smithy.api#documentation": "The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
" } }, "ModelClientConfig": { "target": "com.amazonaws.sagemaker#ModelClientConfig", "traits": { - "smithy.api#documentation": "The timeout and maximum number of retries for processing a transform job\n invocation.
" + "smithy.api#documentation": "The timeout and maximum number of retries for processing a transform job invocation.
" } }, "MaxPayloadInMB": { "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "The\n maximum\n payload size, in MB, used in the\n transform job.
" + "smithy.api#documentation": "The maximum payload size, in MB, used in the transform job.
" } }, "BatchStrategy": { "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.
\nTo enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.
Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.
The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" } }, "TransformInput": { "target": "com.amazonaws.sagemaker#TransformInput", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.
", + "smithy.api#documentation": "Describes the dataset to be transformed and the Amazon S3 location where it is stored.
", "smithy.api#required": {} } }, "TransformOutput": { "target": "com.amazonaws.sagemaker#TransformOutput", "traits": { - "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
" + "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
" } }, "DataCaptureConfig": { @@ -27397,7 +27382,7 @@ "target": "com.amazonaws.sagemaker#TransformResources", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.
", + "smithy.api#documentation": "Describes the resources, including ML instance types and ML instance count, to use for the transform job.
", "smithy.api#required": {} } }, @@ -27412,19 +27397,19 @@ "TransformStartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.
Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.
Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
" } }, "AutoMLJobArn": { @@ -27512,7 +27497,7 @@ "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nThe status of the component. States include:
InProgress
Completed
Failed
A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.
" + "smithy.api#documentation": "A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
" } } }, @@ -27641,7 +27626,7 @@ "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.
\nThis operation applies only to private workforces.
\nLists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.
This operation applies only to private workforces.
The name of the private workforce whose access you want to restrict.\n WorkforceName is automatically set to default when a\n workforce is created and cannot be modified.
The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.
A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", + "smithy.api#documentation": "A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", "smithy.api#required": {} } } @@ -27859,7 +27844,7 @@ "target": "com.amazonaws.sagemaker#DescribeWorkteamResponse" }, "traits": { - "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the\n creation date, the last updated date, membership information, and the work team's Amazon\n Resource Name (ARN).
" + "smithy.api#documentation": "Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
" } }, "com.amazonaws.sagemaker#DescribeWorkteamRequest": { @@ -27885,7 +27870,7 @@ "target": "com.amazonaws.sagemaker#Workteam", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Workteam instance that contains information about the work team.\n
A Workteam instance that contains information about the work team.
The model deployment settings for the SageMaker Canvas application.
\nIn order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM\n execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also\n turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.
The model deployment settings for the SageMaker Canvas application.
In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.
Disables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + "smithy.api#documentation": "Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" } }, "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolioInput": { @@ -28556,7 +28541,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates a trial component from a trial. This doesn't effect other trials the\n component is associated with. Before you can delete a component, you must disassociate the\n component from all trials it is associated with. To associate a trial component with a trial,\n call the AssociateTrialComponent API.
\nTo get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter.\n The list appears in the response under Results.TrialComponent.Parents.
Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.
To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
The list of Amazon Web Services accounts that are trusted when the domain is created in\n VPC-only mode.
" + "smithy.api#documentation": "The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.
" } } }, @@ -28746,19 +28731,19 @@ "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", "traits": { - "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
A collection of settings that configure the RStudioServerPro Domain-level\n app.
A collection of settings that configure the RStudioServerPro Domain-level app.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key.
" + "smithy.api#documentation": "The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.
" } }, "DockerSettings": { @@ -28770,12 +28755,18 @@ "AmazonQSettings": { "target": "com.amazonaws.sagemaker#AmazonQSettings", "traits": { - "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain. The\n AuthMode that you use to create the domain must be SSO.
A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" } } }, "traits": { - "smithy.api#documentation": "A collection of settings that apply to the SageMaker Domain. These settings\n are specified through the CreateDomain API call.
A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.
A collection of RStudioServerPro Domain-level app settings to update. A\n single RStudioServerPro application is created for a domain.
A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.
The configuration for attaching a SageMaker AI user profile name to the execution\n role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.
The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
A collection of settings that configure the Amazon Q experience within the domain.
" } + }, + "UnifiedStudioSettings": { + "target": "com.amazonaws.sagemaker#UnifiedStudioSettings", + "traits": { + "smithy.api#documentation": "The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" + } } }, "traits": { @@ -28875,30 +28872,30 @@ "Bias": { "target": "com.amazonaws.sagemaker#DriftCheckBias", "traits": { - "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is\n set using the model package.
" + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
" } }, "Explainability": { "target": "com.amazonaws.sagemaker#DriftCheckExplainability", "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model\n monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
" } }, "ModelQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model\n monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
" } }, "ModelDataQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", "traits": { - "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the\n model monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.
" } } }, "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckBias": { @@ -28924,7 +28921,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is\n set using the model package.
" + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckExplainability": { @@ -28944,7 +28941,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model\n monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { @@ -28964,7 +28961,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model\n monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckModelQuality": { @@ -28984,7 +28981,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model\n monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DynamicScalingConfiguration": { @@ -29038,7 +29035,7 @@ } }, "traits": { - "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile or\n space for an Amazon SageMaker AI Domain. Permitted users can access this file system in\n Amazon SageMaker AI Studio.
" + "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" } }, "com.amazonaws.sagemaker#EFSFileSystemConfig": { @@ -29055,12 +29052,12 @@ "FileSystemPath": { "target": "com.amazonaws.sagemaker#FileSystemPath", "traits": { - "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker AI Studio.\n Permitted users can access only this directory and below.
" + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.
" } } }, "traits": { - "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile or\n space for an Amazon SageMaker AI Domain.
" + "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.
" } }, "com.amazonaws.sagemaker#EMRStepMetadata": { @@ -29087,7 +29084,7 @@ "LogFilePath": { "target": "com.amazonaws.sagemaker#String1024", "traits": { - "smithy.api#documentation": "The path to the log file where the cluster step's failure root cause \n is recorded.
" + "smithy.api#documentation": "The path to the log file where the cluster step's failure root cause is recorded.
" } } }, @@ -29129,7 +29126,7 @@ "AssociationType": { "target": "com.amazonaws.sagemaker#AssociationEdgeType", "traits": { - "smithy.api#documentation": "The type of the Association(Edge) between the source and destination. For example ContributedTo, \n Produced, or DerivedFrom.
The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.
Toggle that determines whether to rollback to previous configuration if the current\n deployment fails. By default this is turned on. You may turn this off if you want to\n investigate the errors yourself.
", + "smithy.api#documentation": "Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.
", "smithy.api#required": {} } } @@ -29290,7 +29287,7 @@ "target": "com.amazonaws.sagemaker#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of edge devices yet to pick up the deployment in current stage, or in\n progress.
", + "smithy.api#documentation": "The number of edge devices yet to pick up the deployment in current stage, or in progress.
", "smithy.api#required": {} } }, @@ -29467,19 +29464,19 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. \n If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
" } }, "PresetDeploymentType": { "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", "traits": { - "smithy.api#documentation": "The deployment type SageMaker Edge Manager will create. \n Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
" + "smithy.api#documentation": "The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
" } }, "PresetDeploymentConfig": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:
\n\n ComponentName (optional) - Name of the GreenGrass V2 component. If not specified,\n the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager\n packaging job.
\n ComponentDescription (optional) - Description of the component.
\n ComponentVersion (optional) - The version of the component.
Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a\n major.minor.patch number system. For example, version 1.0.0 represents the first\n major release for a component. For more information, see the semantic version specification.
\n\n PlatformOS (optional) - The name of the operating system for the platform.\n Supported platforms include Windows and Linux.
\n PlatformArchitecture (optional) - The processor architecture for the platform.
Supported architectures Windows include: Windows32_x86, Windows64_x64.
\nSupported architectures for Linux include: Linux x86_64, Linux ARMV8.
\nThe configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:
ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager packaging job.
ComponentDescription (optional) - Description of the component.
ComponentVersion (optional) - The version of the component.
Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.
PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.
PlatformArchitecture (optional) - The processor architecture for the platform.
Supported architectures Windows include: Windows32_x86, Windows64_x64.
Supported architectures for Linux include: Linux x86_64, Linux ARMV8.
The deployment type created by SageMaker Edge Manager. Currently only \n supports Amazon Web Services IoT Greengrass Version 2 components.
", + "smithy.api#documentation": "The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.
", "smithy.api#required": {} } }, @@ -29720,13 +29717,13 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the IAM role granting the AutoML job V2 the necessary\n permissions access policies to list, connect to, or manage EMR Serverless jobs. For\n detailed information about the required permissions of this role, see \"How to configure\n AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API\n or Create an AutoML job for time-series forecasting using the API.
", + "smithy.api#documentation": "The ARN of the IAM role granting the AutoML job V2 the necessary permissions access policies to list, connect to, or manage EMR Serverless jobs. For detailed information about the required permissions of this role, see \"How to configure AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API or Create an AutoML job for time-series forecasting using the API.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in\n other contexts at the moment.
\nSpecifies the compute configuration for the EMR Serverless job.
" + "smithy.api#documentation": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for the EMR Serverless job.
" } }, "com.amazonaws.sagemaker#EmrServerlessSettings": { @@ -29735,13 +29732,13 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for\n running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary\n permissions to read and write data attached and a trust relationship with\n EMR Serverless.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary permissions to read and write data attached and a trust relationship with EMR Serverless.
" } }, "Status": { "target": "com.amazonaws.sagemaker#FeatureStatus", "traits": { - "smithy.api#documentation": "Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker\n Canvas application.
" + "smithy.api#documentation": "Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker Canvas application.
" } } }, @@ -29755,18 +29752,18 @@ "AssumableRoleArns": { "target": "com.amazonaws.sagemaker#AssumableRoleArns", "traits": { - "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of\n SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR\n Serverless applications. These roles define the permissions and access policies required\n when performing Amazon EMR-related operations, such as listing, connecting to, or terminating\n Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in\n cross-account access scenarios, where the Amazon EMR resources (clusters or serverless\n applications) are located in a different Amazon Web Services account than the SageMaker\n domain.
" + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain.
" } }, "ExecutionRoleArns": { "target": "com.amazonaws.sagemaker#ExecutionRoleArns", "traits": { - "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances\n or job execution environments to access other Amazon Web Services services and resources needed during the \n runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other\n Amazon Web Services services based on the particular workload requirements.
" + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements.
" } } }, "traits": { - "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
" } }, "com.amazonaws.sagemaker#EnableCapture": { @@ -29790,7 +29787,7 @@ "target": "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioOutput" }, "traits": { - "smithy.api#documentation": "Enables using Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + "smithy.api#documentation": "Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" } }, "com.amazonaws.sagemaker#EnableSagemakerServicecatalogPortfolioInput": { @@ -29857,7 +29854,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "A list of the production variants hosted on the endpoint. Each production variant is a\n model.
" + "smithy.api#documentation": "A list of the production variants hosted on the endpoint. Each production variant is a model.
" } }, "DataCaptureConfig": { @@ -29896,19 +29893,19 @@ "MonitoringSchedules": { "target": "com.amazonaws.sagemaker#MonitoringScheduleList", "traits": { - "smithy.api#documentation": "A list of monitoring schedules for the endpoint. For information about model\n monitoring, see Amazon SageMaker Model Monitor.
" + "smithy.api#documentation": "A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } }, "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "A list of the shadow variants hosted on the endpoint. Each shadow variant is a model\n in shadow mode with production traffic replicated from the production variant.
" + "smithy.api#documentation": "A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.
" } } }, @@ -30046,7 +30043,7 @@ "target": "com.amazonaws.sagemaker#EndpointName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.
An endpoint in customer's account which has enabled DataCaptureConfig enabled.
Whether the Pipe or File is used as the input mode for\n transferring data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.
Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an\n Amazon S3 key. Defaults to FullyReplicated\n
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated
If specified, monitoring jobs substract this time from the start time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" } }, "EndTimeOffset": { "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", "traits": { - "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.
" + "smithy.api#documentation": "If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" } }, "ExcludeFeaturesAttribute": { @@ -30178,13 +30175,13 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "\n The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.\n
" + "smithy.api#documentation": "The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.
" } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "\n If the status of the endpoint is Failed, or the status is InService but update\n operation fails, this provides the reason why it failed.\n
If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about the\n failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.
The status of the endpoint.
OutOfService: Endpoint is not available to take incoming requests.
Creating: CreateEndpoint is executing.
Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.
RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
InService: Endpoint is available to process incoming requests.
Deleting: DeleteEndpoint is executing.
Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.
The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
The properties of an experiment as returned by the Search API.\n For information about experiments, see the \n CreateExperiment API.
" + "smithy.api#documentation": "The properties of an experiment as returned by the Search API. For information about experiments, see the CreateExperiment API.
" } }, "com.amazonaws.sagemaker#ExperimentArn": { @@ -30760,13 +30757,13 @@ "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.
" + "smithy.api#documentation": "The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
" } }, "TrialComponentDisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.
" + "smithy.api#documentation": "The display name for the trial component. If this key isn't specified, the display name is the trial component name.
" } }, "RunName": { @@ -30777,7 +30774,7 @@ } }, "traits": { - "smithy.api#documentation": "Associates a SageMaker job as a trial component with an experiment and trial. Specified when\n you call the following APIs:
\n\n CreateProcessingJob\n
\n\n CreateTrainingJob\n
\n\n CreateTransformJob\n
\nAssociates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
" } }, "com.amazonaws.sagemaker#ExperimentDescription": { @@ -30866,7 +30863,7 @@ "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.
The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
A summary of the properties of an experiment. To get the complete set of properties, call\n the DescribeExperiment API and provide the\n ExperimentName.
A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.
A member of ExplainerConfig that contains configuration parameters for\n the SageMaker Clarify explainer.
A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.
The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted\n users can access only this directory and below.
" + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
" } } }, "traits": { - "smithy.api#documentation": "The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an\n Amazon SageMaker Domain.
" + "smithy.api#documentation": "The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
" } }, "com.amazonaws.sagemaker#FailStepMetadata": { @@ -30978,7 +30975,7 @@ "ErrorMessage": { "target": "com.amazonaws.sagemaker#String3072", "traits": { - "smithy.api#documentation": "A message that you define and then is processed and rendered by \n the Fail step when the error occurs.
" + "smithy.api#documentation": "A message that you define and then is processed and rendered by the Fail step when the error occurs.
" } } }, @@ -31057,7 +31054,7 @@ "target": "com.amazonaws.sagemaker#FeatureName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of a feature. The type must be a string. FeatureName cannot be any\n of the following: is_deleted, write_time,\n api_invocation_time.
The name:
\nMust start with an alphanumeric character.
\nCan only include alphanumeric characters, underscores, and hyphens. Spaces are not\n allowed.
\nThe name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.
The name:
Must start with an alphanumeric character.
Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
A grouping of elements where each element within the collection must have the same\n feature type (String, Integral, or\n Fractional).
\n List: An ordered collection of elements.
\n Set: An unordered collection of unique elements.
\n Vector: A specialized list that represents a fixed-size array of\n elements. The vector dimension is determined by you. Must have elements with\n fractional feature types.
A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).
List: An ordered collection of elements.
Set: An unordered collection of unique elements.
Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.
A list of features. You must include FeatureName and\n FeatureType. Valid feature FeatureTypes are\n Integral, Fractional and String.
A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.
The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup\n FeatureDefinitions.
The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.
The name of the feature that stores the EventTime of a Record in a\n FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to\n the creation or update of a Record in FeatureGroup. All\n Records in the FeatureGroup must have a corresponding\n EventTime.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.
A list of Features. Each Feature must include a\n FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and\n String.
\n FeatureNames cannot be any of the following: is_deleted,\n write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per\n FeatureGroup.
A list of Features. Each Feature must include a FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and String.
FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per FeatureGroup.
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature\n group.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
" } }, "FeatureGroupStatus": { @@ -31183,7 +31180,7 @@ "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "The reason that the FeatureGroup failed to be replicated in the\n OfflineStore. This is failure may be due to a failure to create a\n FeatureGroup in or delete a FeatureGroup from the\n OfflineStore.
The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.
Amazon SageMaker Feature Store stores features in a collection called Feature Group. A\n Feature Group can be visualized as a table which has rows, with a unique identifier for\n each row where each column in the table is a feature. In principle, a Feature Group is\n composed of features and values per features.
" + "smithy.api#documentation": "Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.
" } }, "com.amazonaws.sagemaker#FeatureGroupArn": { @@ -31361,25 +31358,25 @@ "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A timestamp indicating the time of creation time of the\n FeatureGroup.
A timestamp indicating the time of creation time of the FeatureGroup.
The status of a FeatureGroup. The status can be any of the following:\n Creating, Created, CreateFail,\n Deleting or DetailFail.
The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.
Notifies you if replicating data into the OfflineStore has failed. Returns\n either: Active or Blocked.
Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.
The name, ARN, CreationTime, FeatureGroup values,\n LastUpdatedTime and EnableOnlineStorage status of a\n FeatureGroup.
The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.
The metadata for a feature. It can either be metadata that you specify, or metadata that\n is updated automatically.
" + "smithy.api#documentation": "The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.
" } }, "com.amazonaws.sagemaker#FeatureName": { @@ -31615,7 +31612,7 @@ "MountPath": { "target": "com.amazonaws.sagemaker#MountPath", "traits": { - "smithy.api#documentation": "The path within the image to mount the user's EFS home directory. The directory\n should be empty. If not specified, defaults to /home/sagemaker-user.
" + "smithy.api#documentation": "The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
" } }, "DefaultUid": { @@ -31650,7 +31647,7 @@ "target": "com.amazonaws.sagemaker#FileSystemAccessMode", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.
The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
A resource property name. For example, TrainingJobName. For valid property\n names, see SearchRecord. You must\n specify a valid property for the resource.
A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field contains\n one of the following values:
\nThe value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value. Not supported for\n text properties.
The value of Name is greater than or equal to Value. Not\n supported for text properties.
The value of Name is less than Value. Not supported for\n text properties.
The value of Name is less than or equal to Value. Not\n supported for text properties.
The value of Name is one of the comma delimited strings in\n Value. Only supported for text properties.
The value of Name contains the string Value. Only\n supported for text properties.
A SearchExpression can include the Contains operator\n multiple times when the value of Name is one of the following:
\n Experiment.DisplayName\n
\n Experiment.ExperimentName\n
\n Experiment.Tags\n
\n Trial.DisplayName\n
\n Trial.TrialName\n
\n Trial.Tags\n
\n TrialComponent.DisplayName\n
\n TrialComponent.TrialComponentName\n
\n TrialComponent.Tags\n
\n TrialComponent.InputArtifacts\n
\n TrialComponent.OutputArtifacts\n
A SearchExpression can include only one Contains operator\n for all other values of Name. In these cases, if you include multiple\n Contains operators in the SearchExpression, the result is\n the following error message: \"'CONTAINS' operator usage limit of 1\n exceeded.\"
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value. Not supported for text properties.
The value of Name is greater than or equal to Value. Not supported for text properties.
The value of Name is less than Value. Not supported for text properties.
The value of Name is less than or equal to Value. Not supported for text properties.
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
The value of Name contains the string Value. Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: \"'CONTAINS' operator usage limit of 1 exceeded.\"
A value used with Name and Operator to determine which resources\n satisfy the filter's condition. For numerical properties, Value must be an\n integer or floating-point decimal. For timestamp properties, Value must be an ISO\n 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the results\n from the Search API.
\nIf you specify a Value, but not an Operator, SageMaker uses the\n equals operator.
In search, there are several property types:
\nTo define a metric filter, enter a value using the form\n \"Metrics., where \"accuracy\" metric greater than \"0.9\":
\n {\n
\n \"Name\": \"Metrics.accuracy\",\n
\n \"Operator\": \"GreaterThan\",\n
\n \"Value\": \"0.9\"\n
\n }\n
To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.. Decimal hyperparameter values are treated\n as a decimal in a comparison if the specified Value is also a decimal\n value. If the specified Value is an integer, the decimal hyperparameter\n values are treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is less than\n \"0.5\":
\n {\n
\n \"Name\": \"HyperParameters.learning_rate\",\n
\n \"Operator\": \"LessThan\",\n
\n \"Value\": \"0.5\"\n
\n }\n
To define a tag filter, enter a value with the form\n Tags..
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value, but not an Operator, SageMaker uses the equals operator.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GreaterThan\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LessThan\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form Tags.<key>.
The name of the metric with the best result. For a description of the possible objective\n metrics, see AutoMLJobObjective$MetricName.
", + "smithy.api#documentation": "The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
", "smithy.api#required": {} } }, @@ -31883,7 +31880,7 @@ "StandardMetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { - "smithy.api#documentation": "The name of the standard metric. For a description of the standard metrics, see Autopilot\n candidate metrics.
" + "smithy.api#documentation": "The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
" } } }, @@ -31897,14 +31894,14 @@ "Type": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", "traits": { - "smithy.api#documentation": "Select if you want to minimize or maximize the objective metric during hyperparameter\n tuning.
" + "smithy.api#documentation": "Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
" } }, "MetricName": { "target": "com.amazonaws.sagemaker#MetricName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the objective metric. For SageMaker built-in algorithms, metrics are defined\n per algorithm. See the metrics for XGBoost as an\n example. You can also use a custom algorithm for training and define your own metrics.\n For more information, see Define metrics and environment variables.
", + "smithy.api#documentation": "The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.
", "smithy.api#required": {} } }, @@ -31918,7 +31915,7 @@ } }, "traits": { - "smithy.api#documentation": "Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
The Amazon S3 path where the object containing human output will be made available.
\nTo learn more about the format of Amazon A2I output data, see Amazon A2I\n Output Data.
", + "smithy.api#documentation": "The Amazon S3 path where the object containing human output will be made available.
To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.
", "smithy.api#required": {} } }, @@ -32261,12 +32258,12 @@ "AmazonBedrockRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in\n Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that\n establishes bedrock.amazonaws.com as a service principal.
The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.
The generative AI settings for the SageMaker Canvas application.
\nConfigure these settings for Canvas users starting chats with generative AI foundation models.\n For more information, see \n Use generative AI with foundation models.
" + "smithy.api#documentation": "The generative AI settings for the SageMaker Canvas application.
Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.
" } }, "com.amazonaws.sagemaker#GetDeviceFleetReport": { @@ -32419,7 +32416,7 @@ "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" }, "traits": { - "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services\n Identity and Access Management User Guide..
" + "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
" } }, "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { @@ -32463,7 +32460,7 @@ "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusOutput" }, "traits": { - "smithy.api#documentation": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create\n SageMaker projects.
" + "smithy.api#documentation": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" } }, "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatusInput": { @@ -32501,7 +32498,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies\n that you can apply to your SageMaker endpoint.
" + "smithy.api#documentation": "Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
" } }, "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest": { @@ -32518,13 +32515,13 @@ "RecommendationId": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The recommendation ID of a previously completed inference recommendation. This ID should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the EndpointName field.
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.
Specify either this field or the RecommendationId field.
An auto-complete API for the search functionality in the SageMaker console. It returns\n suggestions of possible matches for the property name to use in Search queries.\n Provides suggestions for HyperParameters, Tags, and\n Metrics.
An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
A list of property names for a Resource that match a\n SuggestionQuery.
A list of property names for a Resource that match a SuggestionQuery.
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:
{\"username\": UserName, \"password\": Password}
Specifies configuration details for a Git repository in your Amazon Web Services\n account.
" + "smithy.api#documentation": "Specifies configuration details for a Git repository in your Amazon Web Services account.
" } }, "com.amazonaws.sagemaker#GitConfigForUpdate": { @@ -32685,12 +32682,12 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:
{\"username\": UserName, \"password\": Password}
Specifies configuration details for a Git repository when the repository is\n updated.
" + "smithy.api#documentation": "Specifies configuration details for a Git repository when the repository is updated.
" } }, "com.amazonaws.sagemaker#GitConfigUrl": { @@ -32781,7 +32778,7 @@ } }, "traits": { - "smithy.api#documentation": "The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.
" + "smithy.api#documentation": "The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.
" } }, "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { @@ -32814,12 +32811,12 @@ "CountryCode": { "target": "com.amazonaws.sagemaker#CountryCode", "traits": { - "smithy.api#documentation": "The country code for the holiday calendar.
\nFor the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your\n choice.
" + "smithy.api#documentation": "The country code for the holiday calendar.
For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.
" } } }, "traits": { - "smithy.api#documentation": "Stores the holiday featurization attributes applicable to each item of time-series\n datasets during the training of a forecasting model. This allows the model to identify\n patterns associated with specific holidays.
" + "smithy.api#documentation": "Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.
" } }, "com.amazonaws.sagemaker#HookParameters": { @@ -32847,13 +32844,13 @@ "target": "com.amazonaws.sagemaker#HubContentArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of your private model hub content. This should be a ModelReference\n resource type that points to a SageMaker JumpStart public hub model.
The ARN of your private model hub content. This should be a ModelReference resource type that points to a SageMaker JumpStart public hub model.
The configuration for a private hub model reference that points to a public SageMaker JumpStart model.
\nFor more information about private hubs, see Private curated hubs for foundation model access control in JumpStart.
" + "smithy.api#documentation": "The configuration for a private hub model reference that points to a public SageMaker JumpStart model.
For more information about private hubs, see Private curated hubs for foundation model access control in JumpStart.
" } }, "com.amazonaws.sagemaker#HubArn": { @@ -33409,20 +33406,30 @@ } } }, + "com.amazonaws.sagemaker#HumanLoopActivationConditions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10240 + }, + "smithy.api#mediaType": "application/json" + } + }, "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig": { "type": "structure", "members": { "HumanLoopActivationConditions": { - "target": "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions", + "target": "com.amazonaws.sagemaker#HumanLoopActivationConditions", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. \n The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see \n JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI \n in the Amazon SageMaker Developer Guide.
", + "smithy.api#documentation": "JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required\n format of activation conditions.
" + "smithy.api#documentation": "Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.
" } }, "com.amazonaws.sagemaker#HumanLoopActivationConfig": { @@ -33432,7 +33439,7 @@ "target": "com.amazonaws.sagemaker#HumanLoopActivationConditionsConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Container structure for defining under what conditions SageMaker creates a human\n loop.
", + "smithy.api#documentation": "Container structure for defining under what conditions SageMaker creates a human loop.
", "smithy.api#required": {} } } @@ -33448,7 +33455,7 @@ "target": "com.amazonaws.sagemaker#WorkteamArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Amazon Resource Name (ARN) of a team of workers. To learn more about the types of\n workforces and work teams you can create and use with Amazon A2I, see Create\n and Manage Workforces.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.
", "smithy.api#required": {} } }, @@ -33456,7 +33463,7 @@ "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
\nYou can use standard HTML and Crowd HTML Elements to create a custom worker task\n template. You use this template to create a human task UI.
\nTo learn how to create a custom HTML template, see Create Custom Worker\n Task Template.
\nTo learn how to create a human task UI, which is a worker task template that can be used\n in a flow definition, see Create and Delete a Worker Task Templates.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the human task user interface.
You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.
To learn how to create a custom HTML template, see Create Custom Worker Task Template.
To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.
", "smithy.api#required": {} } }, @@ -33480,7 +33487,7 @@ "target": "com.amazonaws.sagemaker#FlowDefinitionTaskCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of distinct workers who will perform the same task on each object.\n For example, if TaskCount is set to 3 for an image classification \n labeling job, three workers will classify each input image. \n Increasing TaskCount can improve label accuracy.
The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.
The amount of time that a worker has to complete a task. The default value is 3,600\n seconds (1 hour).
" + "smithy.api#documentation": "The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
" } }, "TaskKeywords": { @@ -33517,7 +33524,7 @@ "target": "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. \n The default field settings and JSON parsing rules are different based on the integration source. Valid values:
", + "smithy.api#documentation": "Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:
", "smithy.api#required": {} } } @@ -33541,20 +33548,20 @@ "target": "com.amazonaws.sagemaker#UiConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about the user interface that workers use to complete the labeling\n task.
", + "smithy.api#documentation": "Information about the user interface that workers use to complete the labeling task.
", "smithy.api#required": {} } }, "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.
\nFor built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n
\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n
\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n
\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n
\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n
\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n
\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n
\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n
\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n
\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n
\n 3D Point Cloud Modalities\n
\nUse the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.
\n\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n
\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n
\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n
\n Use the following ARNs for Label Verification and Adjustment Jobs\n
\nUse label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .
\n\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n
\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n
\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n
\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n
\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n
\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n
\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n
\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n
\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.
\n\n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
\n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n
The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass
Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass
Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass
Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection
Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking
3D Point Cloud Modalities
Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.
3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection
3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation
Use the following ARNs for Label Verification and Adjustment Jobs
Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .
Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox
Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox
Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation
Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection
Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking
3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection
3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking
3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation
Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.
" + "smithy.api#documentation": "Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
" } }, "TaskTitle": { @@ -33585,20 +33592,20 @@ "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The amount of time that a worker has to complete a task.
\nIf you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).
\nIf you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:
\nFor image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).
\nFor 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe amount of time that a worker has to complete a task.
If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).
If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:
For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).
For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.
\nIf you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).
\nIf you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
\nThe length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.
If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).
If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.
Defines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.
" + "smithy.api#documentation": "Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.
" } }, "AnnotationConsolidationConfig": { @@ -33699,7 +33706,7 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": " The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The name of the resource algorithm to use for the hyperparameter tuning job. If you\n specify a value for this parameter, do not specify a value for\n TrainingImage.
The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.
An array of MetricDefinition objects that specify the\n metrics\n that the algorithm emits.
" + "smithy.api#documentation": "An array of MetricDefinition objects that specify the metrics that the algorithm emits.
" } } }, "traits": { - "smithy.api#documentation": "Specifies\n which\n training algorithm to use for training jobs that a hyperparameter\n tuning job launches and the metrics to monitor.
" + "smithy.api#documentation": "Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
" } }, "com.amazonaws.sagemaker#HyperParameterKey": { @@ -33786,7 +33793,7 @@ "target": "com.amazonaws.sagemaker#ParameterType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.
The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.
" + "smithy.api#documentation": "Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
" } }, "IsRequired": { @@ -33811,7 +33818,7 @@ "DefaultValue": { "target": "com.amazonaws.sagemaker#HyperParameterValue", "traits": { - "smithy.api#documentation": "The default value for this hyperparameter. If a default value is specified, a\n hyperparameter cannot be required.
" + "smithy.api#documentation": "The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
" } } }, @@ -33849,14 +33856,14 @@ "StaticHyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "Specifies the values of hyperparameters\n that\n do not change for the tuning job.
" + "smithy.api#documentation": "Specifies the values of hyperparameters that do not change for the tuning job.
" } }, "AlgorithmSpecification": { "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.
", + "smithy.api#documentation": "The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
", "smithy.api#required": {} } }, @@ -33864,66 +33871,66 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the\n IAM\n role associated with the training jobs that the tuning job\n launches.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "An array of Channel objects that\n specify\n the\n input for the training jobs that the tuning job launches.
" + "smithy.api#documentation": "An array of Channel objects that specify the input for the training jobs that the tuning job launches.
" } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the training jobs\n that this hyperparameter tuning job launches to connect to. Control access to and from\n your training container by configuring the VPC. For more information, see Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.
" + "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" } }, "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the path to the Amazon S3 bucket where you\n store\n model artifacts from the training jobs that the tuning job\n launches.
", + "smithy.api#documentation": "Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.
\nStorage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.
If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.
The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.
Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.
The configuration for the hyperparameter tuning resources, including the compute\n instances and storage volumes, used for training jobs launched by the tuning job. By\n default, storage volumes hold model artifacts and incremental states. Choose\n File for TrainingInputMode in the\n AlgorithmSpecification parameter to additionally store training data in\n the storage volume (optional).
The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).
Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, SageMaker ends the training job. Use this API to cap model training costs.
", + "smithy.api#documentation": "Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
", "smithy.api#required": {} } }, "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.
" + "smithy.api#documentation": "Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
" } }, "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or\n not (False).
A Boolean indicating whether managed spot training is enabled (True) or not (False).
The number of times to retry the job when the job fails due to an\n InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics and variables for more information.
\nThe maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.
The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.
Defines\n the training jobs launched by a hyperparameter tuning job.
" + "smithy.api#documentation": "Defines the training jobs launched by a hyperparameter tuning job.
" } }, "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName": { @@ -34057,14 +34064,14 @@ "TrainingEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
The\n status\n of the training job.
", + "smithy.api#documentation": "The status of the training job.
", "smithy.api#required": {} } }, @@ -34072,26 +34079,26 @@ "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A\n list of the hyperparameters for which you specified ranges to\n search.
", + "smithy.api#documentation": "A list of the hyperparameters for which you specified ranges to search.
", "smithy.api#required": {} } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "The\n reason that the training job failed.\n
" + "smithy.api#documentation": "The reason that the training job failed.
" } }, "FinalHyperParameterTuningJobObjectiveMetric": { "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", "traits": { - "smithy.api#documentation": "The FinalHyperParameterTuningJobObjectiveMetric object that specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.
" + "smithy.api#documentation": "The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
" } }, "ObjectiveStatus": { "target": "com.amazonaws.sagemaker#ObjectiveStatus", "traits": { - "smithy.api#documentation": "The status of the objective metric for the training job:
\nSucceeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.
\nPending: The training job is in progress and evaluation of its final objective\n metric is pending.
\nFailed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.
\nThe status of the objective metric for the training job:
Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
Pending: The training job is in progress and evaluation of its final objective metric is pending.
Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
The instance type used for processing of hyperparameter optimization jobs. Choose from\n general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge\n or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more\n information about instance types, see instance type\n descriptions.
", + "smithy.api#documentation": "The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.
", "smithy.api#required": {} } }, @@ -34125,7 +34132,7 @@ "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more\n information.
The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The volume size in GB of the data to be processed for hyperparameter optimization\n (optional).
", + "smithy.api#documentation": "The volume size in GB of the data to be processed for hyperparameter optimization (optional).
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration for hyperparameter tuning resources for use in training jobs\n launched by the tuning job. These resources include compute instances and storage\n volumes. Specify one or more compute instance configurations and allocation strategies\n to select resources (optional).
" + "smithy.api#documentation": "The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).
" } }, "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs": { @@ -34170,18 +34177,18 @@ "NumberOfTrainingJobsObjectiveNotImproving": { "target": "com.amazonaws.sagemaker#Integer", "traits": { - "smithy.api#documentation": "The number of training jobs launched by a tuning job that are not improving (1% or\n less) as measured by model performance evaluated against an objective function.
" + "smithy.api#documentation": "The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.
" } }, "ConvergenceDetectedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The time in timestamp format that AMT detected model convergence, as defined by a lack\n of significant improvement over time based on criteria developed over a wide range of\n diverse benchmarking tests.
" + "smithy.api#documentation": "The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.
" } } }, "traits": { - "smithy.api#documentation": "A structure that contains runtime information about both current and completed\n hyperparameter tuning jobs.
" + "smithy.api#documentation": "A structure that contains runtime information about both current and completed hyperparameter tuning jobs.
" } }, "com.amazonaws.sagemaker#HyperParameterTuningJobConfig": { @@ -34191,40 +34198,40 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies how hyperparameter tuning chooses the combinations of hyperparameter values\n to use for the training job it launches. For information about search strategies, see\n How\n Hyperparameter Tuning Works.
", + "smithy.api#documentation": "Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.
", "smithy.api#required": {} } }, "StrategyConfig": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyConfig", "traits": { - "smithy.api#documentation": "The configuration for the Hyperband optimization strategy. This parameter\n should be provided only if Hyperband is selected as the strategy for\n HyperParameterTuningJobConfig.
The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.
The HyperParameterTuningJobObjective specifies the objective metric used to\n evaluate the performance of training jobs launched by this tuning job.
" + "smithy.api#documentation": "The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.
" } }, "ResourceLimits": { "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training and parallel training jobs that can\n be used for this hyperparameter tuning job.
", + "smithy.api#documentation": "The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.
", "smithy.api#required": {} } }, "ParameterRanges": { "target": "com.amazonaws.sagemaker#ParameterRanges", "traits": { - "smithy.api#documentation": "The ParameterRanges\n object that specifies the ranges of hyperparameters that this tuning job searches over\n to find the optimal configuration for the highest model performance against your chosen\n objective metric.
" + "smithy.api#documentation": "The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.
" } }, "TrainingJobEarlyStoppingType": { "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", "traits": { - "smithy.api#documentation": "Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early\n stopping.
\nSageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.
\nSpecifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early stopping.
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
A value used to initialize a pseudo-random number generator. Setting a random seed and\n using the same seed later for the same tuning job will allow hyperparameter optimization\n to find more a consistent hyperparameter configuration between the two runs.
" + "smithy.api#documentation": "A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.
" } } }, @@ -34283,13 +34290,13 @@ "target": "com.amazonaws.sagemaker#MetricName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n name of the metric to use for the objective metric.
", + "smithy.api#documentation": "The name of the metric to use for the objective metric.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning\n uses the value of this metric to evaluate the training jobs it launches, and returns the\n training job that results in either the highest or lowest value for this metric,\n depending on the value you specify for the Type parameter. If you want to\n define a custom objective metric, see Define metrics and environment variables.
Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.
An entity returned by the SearchRecord API\n containing the properties of a hyperparameter tuning job.
" + "smithy.api#documentation": "An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.
" } }, "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions": { @@ -34486,12 +34493,12 @@ "HyperbandStrategyConfig": { "target": "com.amazonaws.sagemaker#HyperbandStrategyConfig", "traits": { - "smithy.api#documentation": "The configuration for the object that specifies the Hyperband strategy.\n This parameter is only supported for the Hyperband selection for\n Strategy within the HyperParameterTuningJobConfig API.
The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.
The configuration for a training job launched by a hyperparameter tuning job. Choose\n Bayesian for Bayesian optimization, and Random for random\n search optimization. For more advanced use cases, use Hyperband, which\n evaluates objective metrics for training jobs after every epoch. For more information about\n strategies, see How Hyperparameter\n Tuning Works.
The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.
The strategy hyperparameter tuning uses to find the best combination of\n hyperparameters for your model.
" + "smithy.api#documentation": "The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.
" } }, "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries": { @@ -34547,7 +34554,7 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The\n Amazon\n Resource Name (ARN) of the tuning job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tuning job.
", "smithy.api#required": {} } }, @@ -34555,7 +34562,7 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the\n tuning\n job.
", + "smithy.api#documentation": "The status of the tuning job.
", "smithy.api#required": {} } }, @@ -34563,7 +34570,7 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n evaluate\n at each iteration.
", + "smithy.api#documentation": "Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
", "smithy.api#required": {} } }, @@ -34584,14 +34591,14 @@ "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the tuning job was\n modified.
" + "smithy.api#documentation": "The date and time that the tuning job was modified.
" } }, "TrainingJobStatusCounters": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of training\n jobs, categorized by status, that this tuning job launched.
", + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
", "smithy.api#required": {} } }, @@ -34599,14 +34606,14 @@ "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of training jobs,\n categorized by objective metric status, that this tuning job launched.
", + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
", "smithy.api#required": {} } }, "ResourceLimits": { "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training jobs and parallel training jobs\n allowed for this tuning job.
" + "smithy.api#documentation": "The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
" } } }, @@ -34621,7 +34628,7 @@ "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.
\nHyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.
", + "smithy.api#documentation": "An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.
Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.
", "smithy.api#required": {} } }, @@ -34629,13 +34636,13 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies one of the following:
\nThe new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.
\nThe new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.
\nSpecifies one of the following:
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
Specifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.
\nAll training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.
\nAll training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.
\nSpecifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.
All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.
" + "smithy.api#documentation": "The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
" } }, "InstanceCount": { @@ -34682,30 +34689,30 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", "traits": { - "smithy.api#documentation": "The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.
SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.
\nThe volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.
\nKMS Key ID:
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS key:
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
KMS Key ID:
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.
The strategy that determines the order of preference for resources specified in\n InstanceConfigs used in hyperparameter optimization.
The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.
If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.
The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs.\n HyperParameterTuningResourceConfig is similar to\n ResourceConfig, but has the additional InstanceConfigs and\n AllocationStrategy fields to allow for flexible instance management.\n Specify one or more instance types, count, and the allocation strategy for instance\n selection.
\n HyperParameterTuningResourceConfig supports the capabilities of\n ResourceConfig with the exception of\n KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools\n by default, which reuse clusters between training jobs.
The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.
HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.
The minimum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. If the value for MinResource has not\n been reached, the training job is not stopped by Hyperband.
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.
The maximum number of resources (such as epochs) that can be used by a training job\n launched by a hyperparameter tuning job. Once a job reaches the MaxResource\n value, it is stopped. If a value for MaxResource is not provided, and\n Hyperband is selected as the hyperparameter tuning strategy,\n HyperbandTraining attempts to infer MaxResource from the\n following keys (if present) in StaticsHyperParameters:
\n epochs\n
\n numepochs\n
\n n-epochs\n
\n n_epochs\n
\n num_epochs\n
If HyperbandStrategyConfig is unable to infer a value for\n MaxResource, it generates a validation error. The maximum value is 20,000\n epochs. All metrics that correspond to an objective metric are used to derive early stopping\n decisions. For distributed training jobs,\n ensure that duplicate metrics are not printed in the logs across the individual nodes in a\n training job. If multiple nodes are publishing duplicate or incorrect metrics, training\n jobs may make an incorrect stopping decision and stop the job prematurely.
The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:
epochs
numepochs
n-epochs
n_epochs
num_epochs
If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.
The configuration for Hyperband, a multi-fidelity based hyperparameter\n tuning strategy. Hyperband uses the final and intermediate results of a\n training job to dynamically allocate resources to utilized hyperparameter configurations\n while automatically stopping under-performing configurations. This parameter should be\n provided only if Hyperband is selected as the StrategyConfig\n under the HyperParameterTuningJobConfig API.
The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.
The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages and project entities only.
" + "smithy.api#documentation": "The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.
" } }, "com.amazonaws.sagemaker#IamPolicyConstraints": { @@ -34836,18 +34843,18 @@ "Status": { "target": "com.amazonaws.sagemaker#FeatureStatus", "traits": { - "smithy.api#documentation": "Describes whether OAuth for a data source is enabled or disabled in the Canvas\n application.
" + "smithy.api#documentation": "Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
" } }, "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your\n identity provider, such as the client ID and secret, authorization URL, and token URL.
" + "smithy.api#documentation": "The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.
" } } }, "traits": { - "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.
" + "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.
" } }, "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { @@ -34874,7 +34881,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" + "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it down.
" } }, "MinIdleTimeoutInMinutes": { @@ -34966,7 +34973,7 @@ } }, "traits": { - "smithy.api#documentation": "A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from\n a common base container image. Each of these container images is represented by a SageMaker AI\n ImageVersion.
A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ImageVersion.
How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to generate.
" } } }, "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the image classification problem\n type.
" + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the image classification problem type.
" } }, "com.amazonaws.sagemaker#ImageConfig": { @@ -35010,19 +35017,19 @@ "target": "com.amazonaws.sagemaker#RepositoryAccessMode", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Set this to one of the following values:
\n\n Platform - The model image is hosted in Amazon ECR.
\n Vpc - The model image is hosted in a private Docker registry in\n your VPC.
Set this to one of the following values:
Platform - The model image is hosted in Amazon ECR.
Vpc - The model image is hosted in a private Docker registry in your VPC.
(Optional) Specifies an authentication configuration for the private docker registry\n where your model image is hosted. Specify a value for this property only if you\n specified Vpc as the value for the RepositoryAccessMode field,\n and the private Docker registry where the model image is hosted requires\n authentication.
(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.
Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC).
" + "smithy.api#documentation": "Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
" } }, "com.amazonaws.sagemaker#ImageContainerImage": { @@ -35262,7 +35269,7 @@ } }, "traits": { - "smithy.api#documentation": "A version of a SageMaker AI Image. A version represents an existing container\n image.
A version of a SageMaker AI Image. A version represents an existing container image.
Specifies the endpoint capacity type.
\nThe endpoint activates based on the number of inference component\n copies.
\nThe endpoint activates based on the specified percentage of capacity.
\nSpecifies the endpoint capacity type.
The endpoint activates based on the number of inference component copies.
The endpoint activates based on the specified percentage of capacity.
Defines the capacity size, either as a number of inference component copies or a\n capacity percentage.
", + "smithy.api#documentation": "Defines the capacity size, either as a number of inference component copies or a capacity percentage.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a rolling\n deployment or a rollback strategy. You can specify your batches as either of the\n following:
\nA count of inference component copies
\nThe overall percentage or your fleet
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value parameter to 100%, then SageMaker AI uses a blue/green rollback\n strategy and rolls all traffic back to the blue fleet.
Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:
A count of inference component copies
The overall percentage or your fleet
For a rollback strategy, if you don't specify the fields in this object, or if you set the Value parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
The number of CPU cores to allocate to run a model that you assign to an inference\n component.
" + "smithy.api#documentation": "The number of CPU cores to allocate to run a model that you assign to an inference component.
" } }, "NumberOfAcceleratorDevicesRequired": { "target": "com.amazonaws.sagemaker#NumberOfAcceleratorDevices", "traits": { - "smithy.api#documentation": "The number of accelerators to allocate to run a model that you assign to an inference\n component. Accelerators include GPUs and Amazon Web Services Inferentia.
" + "smithy.api#documentation": "The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.
" } }, "MinMemoryRequiredInMb": { "target": "com.amazonaws.sagemaker#MemoryInMb", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum MB of memory to allocate to run a model that you assign to an inference\n component.
", + "smithy.api#documentation": "The minimum MB of memory to allocate to run a model that you assign to an inference component.
", "smithy.api#required": {} } }, "MaxMemoryRequiredInMb": { "target": "com.amazonaws.sagemaker#MemoryInMb", "traits": { - "smithy.api#documentation": "The maximum MB of memory to allocate to run a model that you assign to an inference\n component.
" + "smithy.api#documentation": "The maximum MB of memory to allocate to run a model that you assign to an inference component.
" } } }, "traits": { - "smithy.api#documentation": "Defines the compute resources to allocate to run a model, plus any adapter models, that\n you assign to an inference component. These resources include CPU cores, accelerators, and\n memory.
" + "smithy.api#documentation": "Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.
" } }, "com.amazonaws.sagemaker#InferenceComponentContainerSpecification": { @@ -35631,18 +35638,18 @@ "ArtifactUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training,\n are stored. This path must point to a single gzip compressed tar archive (.tar.gz\n suffix).
" + "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" } }, "Environment": { "target": "com.amazonaws.sagemaker#EnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the\n Environment string-to-string map can have length of up to 1024. We support up to 16 entries\n in the map.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.
" } } }, "traits": { - "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" + "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy with an inference component.
" } }, "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary": { @@ -35683,7 +35690,7 @@ "target": "com.amazonaws.sagemaker#InferenceComponentRollingUpdatePolicy", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker AI\n endpoint.
", + "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.
", "smithy.api#required": {} } }, @@ -35692,7 +35699,7 @@ } }, "traits": { - "smithy.api#documentation": "The deployment configuration for an endpoint that hosts inference components. The\n configuration includes the desired deployment strategy and rollback settings.
" + "smithy.api#documentation": "The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.
" } }, "com.amazonaws.sagemaker#InferenceComponentName": { @@ -35722,7 +35729,7 @@ "target": "com.amazonaws.sagemaker#InferenceComponentCapacitySize", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet,\n and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of\n the copy count of the inference component.
", + "smithy.api#documentation": "The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.
", "smithy.api#required": {} } }, @@ -35730,7 +35737,7 @@ "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The length of the baking period, during which SageMaker AI monitors alarms for each\n batch on the new fleet.
", + "smithy.api#documentation": "The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.
", "smithy.api#required": {} } }, @@ -35743,12 +35750,12 @@ "RollbackMaximumBatchSize": { "target": "com.amazonaws.sagemaker#InferenceComponentCapacitySize", "traits": { - "smithy.api#documentation": "The batch size for a rollback to the old endpoint fleet. If this field is absent, the\n value is set to the default, which is 100% of the total capacity. When the default is used,\n SageMaker AI provisions the entire capacity of the old fleet at once during\n rollback.
" + "smithy.api#documentation": "The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.
" } } }, "traits": { - "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker AI inference\n component.
" + "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker AI inference component.
" } }, "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { @@ -35758,7 +35765,7 @@ "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of runtime copies of the model container to deploy with the inference\n component. Each copy can serve inference requests.
", + "smithy.api#documentation": "The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.
", "smithy.api#required": {} } } @@ -35773,7 +35780,7 @@ "DesiredCopyCount": { "target": "com.amazonaws.sagemaker#InferenceComponentCopyCount", "traits": { - "smithy.api#documentation": "The number of runtime copies of the model container that you requested to deploy with\n the inference component.
" + "smithy.api#documentation": "The number of runtime copies of the model container that you requested to deploy with the inference component.
" } }, "CurrentCopyCount": { @@ -35784,7 +35791,7 @@ } }, "traits": { - "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference\n component.
" + "smithy.api#documentation": "Details about the runtime settings for the model that is deployed with the inference component.
" } }, "com.amazonaws.sagemaker#InferenceComponentSortKey": { @@ -35816,13 +35823,13 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "The name of an existing SageMaker AI model object in your account that you want to\n deploy with the inference component.
" + "smithy.api#documentation": "The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.
" } }, "Container": { "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecification", "traits": { - "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy\n with an inference component.
" + "smithy.api#documentation": "Defines a container that provides the runtime environment for a model that you deploy with an inference component.
" } }, "StartupParameters": { @@ -35834,18 +35841,18 @@ "ComputeResourceRequirements": { "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", "traits": { - "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
\nOmit this parameter if your request is meant to create an adapter inference component.\n An adapter inference component is loaded by a base inference component, and it uses the\n compute resources of the base inference component.
" + "smithy.api#documentation": "The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.
Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.
" } }, "BaseInferenceComponentName": { "target": "com.amazonaws.sagemaker#InferenceComponentName", "traits": { - "smithy.api#documentation": "The name of an existing inference component that is to contain the inference component\n that you're creating with your request.
\nSpecify this parameter only if your request is meant to create an adapter inference\n component. An adapter inference component contains the path to an adapter model. The\n purpose of the adapter model is to tailor the inference output of a base foundation model,\n which is hosted by the base inference component. The adapter inference component uses the\n compute resources that you assigned to the base inference component.
\nWhen you create an adapter inference component, use the Container parameter\n to specify the location of the adapter artifacts. In the parameter value, use the\n ArtifactUrl parameter of the\n InferenceComponentContainerSpecification data type.
Before you can create an adapter inference component, you must have an existing\n inference component that contains the foundation model that you want to adapt.
" + "smithy.api#documentation": "The name of an existing inference component that is to contain the inference component that you're creating with your request.
Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.
When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.
Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.
" } } }, "traits": { - "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the model, container, and compute resources.
" } }, "com.amazonaws.sagemaker#InferenceComponentSpecificationSummary": { @@ -35854,13 +35861,13 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "The name of the SageMaker AI model object that is deployed with the inference\n component.
" + "smithy.api#documentation": "The name of the SageMaker AI model object that is deployed with the inference component.
" } }, "Container": { "target": "com.amazonaws.sagemaker#InferenceComponentContainerSpecificationSummary", "traits": { - "smithy.api#documentation": "Details about the container that provides the runtime environment for the model that is\n deployed with the inference component.
" + "smithy.api#documentation": "Details about the container that provides the runtime environment for the model that is deployed with the inference component.
" } }, "StartupParameters": { @@ -35872,7 +35879,7 @@ "ComputeResourceRequirements": { "target": "com.amazonaws.sagemaker#InferenceComponentComputeResourceRequirements", "traits": { - "smithy.api#documentation": "The compute resources allocated to run the model, plus any \n adapter models, that you assign to the inference component.
" + "smithy.api#documentation": "The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.
" } }, "BaseInferenceComponentName": { @@ -35892,13 +35899,13 @@ "ModelDataDownloadTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this inference\n component.
" + "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.
" } }, "ContainerStartupHealthCheckTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" + "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" } } }, @@ -36024,7 +36031,7 @@ "target": "com.amazonaws.sagemaker#InferenceExecutionMode", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "How containers in a multi-container are run. The following values are valid.
\n\n SERIAL - Containers run as a serial pipeline.
\n DIRECT - Only the individual container that you specify is\n run.
How containers in a multi-container are run. The following values are valid.
SERIAL - Containers run as a serial pipeline.
DIRECT - Only the individual container that you specify is run.
\n The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\n server-side encryption.\n
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
" } }, "ContentType": { @@ -36128,7 +36135,7 @@ } }, "traits": { - "smithy.api#documentation": "The start and end times of an inference experiment.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" + "smithy.api#documentation": "The start and end times of an inference experiment.
The maximum duration that you can set for an inference experiment is 30 days.
" } }, "com.amazonaws.sagemaker#InferenceExperimentStatus": { @@ -36233,7 +36240,7 @@ "Schedule": { "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", "traits": { - "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
\nThe maximum duration that you can set for an inference experiment is 30 days.
" + "smithy.api#documentation": "The duration for which the inference experiment ran or will run.
The maximum duration that you can set for an inference experiment is 30 days.
" } }, "Status": { @@ -36281,7 +36288,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n
" + "smithy.api#documentation": "The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
" } } }, @@ -36470,7 +36477,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker \n to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "smithy.api#required": {} } }, @@ -36497,7 +36504,7 @@ "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" } }, "ModelPackageVersionArn": { @@ -36518,7 +36525,7 @@ "target": "com.amazonaws.sagemaker#RecommendationStepType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
The type of the subtask.
BENCHMARK: Evaluate the performance of your model on different instance types.
A returned array object for the Steps response field in the\n ListInferenceRecommendationsJobSteps API command.
A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.
A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" + "smithy.api#documentation": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
This parameter is required for unversioned models, and optional for versioned models.
" } }, "SupportedRealtimeInferenceInstanceTypes": { "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", "traits": { - "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
\nThis parameter is required for unversioned models, and optional for versioned\n models.
" + "smithy.api#documentation": "A list of the instance types that are used to generate inferences in real-time.
This parameter is required for unversioned models, and optional for versioned models.
" } }, "SupportedContentTypes": { @@ -36622,7 +36629,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network \n connectivity.
" + "smithy.api#documentation": "Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.
" } }, "com.amazonaws.sagemaker#InitialInstanceCount": { @@ -36656,33 +36663,33 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix).
", + "smithy.api#documentation": "The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
", "smithy.api#required": {} } }, "DataInputConfig": { "target": "com.amazonaws.sagemaker#DataInputConfig", "traits": { - "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are Framework specific.
\n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.
Examples for one input:
\nIf using the console,\n {\"input\":[1,1024,1024,3]}\n
If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n
Examples for two inputs:
\nIf using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n
If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n
\n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"input_1\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n
Examples for two inputs:
\nIf using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n
If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n
\n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW\n format) of the expected data inputs in order using a dictionary format for your\n trained model. The dictionary formats required for the console and CLI are\n different.
Examples for one input:
\nIf using the console,\n {\"data\":[1,3,1024,1024]}\n
If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n
Examples for two inputs:
\nIf using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n
If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n
\n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.
Examples for one input in dictionary format:
\nIf using the console,\n {\"input0\":[1,3,224,224]}\n
If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n
Example for one input in list format:\n [[1,3,224,224]]\n
Examples for two inputs in dictionary format:
\nIf using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n
If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n
Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n
\n XGBOOST: input data name and shape are not needed.
\n DataInputConfig supports the following parameters for CoreML\n TargetDevice (ML Model format):
\n shape: Input shape, for example {\"input_1\": {\"shape\":\n [1,224,224,3]}}. In addition to static input shapes, CoreML converter\n supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know\n the input shape will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224,\n 3]}}\n
Enumerated shapes. Sometimes, the models are trained to work only on a\n select set of inputs. You can enumerate all supported input shapes, for\n example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160,\n 3]]}}\n
\n default_shape: Default input shape. You can set a default shape\n during conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1,\n 224, 224, 3]}}\n
\n type: Input type. Allowed values: Image and\n Tensor. By default, the converter generates an ML Model with\n inputs of type Tensor (MultiArray). User can set input type to be Image. Image\n input type requires additional input parameters such as bias and\n scale.
\n bias: If the input type is an Image, you need to provide the bias\n vector.
\n scale: If the input type is an Image, you need to provide a scale\n factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig\n CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:
Tensor type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3]}}\n
Tensor type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224]}]\n
Image type input:
\n\n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3],\n [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\",\n \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Image type input without input name (PyTorch):
\n\n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]],\n \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1],\n \"scale\": 0.007843137255}]\n
\n \"CompilerOptions\": {\"class_labels\":\n \"imagenet_labels_1000.txt\"}\n
Depending on the model format, DataInputConfig requires the following\n parameters for ml_eia2\n OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names\n from signature_def_key and the input model shapes for\n DataInputConfig. Specify the signature_def_key in\n \n OutputConfig:CompilerOptions\n if the model does not\n use TensorFlow's default signature def key. For example:
\n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n
\n \"CompilerOptions\": {\"signature_def_key\":\n \"serving_custom\"}\n
For TensorFlow models saved as a frozen graph, specify the input tensor names\n and shapes in DataInputConfig and the output tensor names for\n output_names in \n OutputConfig:CompilerOptions\n . For\n example:
\n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224,\n 3]}\n
\n \"CompilerOptions\": {\"output_names\":\n [\"output_tensor:0\"]}\n
Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.
TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {\"input\":[1,1024,1024,3]}
If using the CLI, {\\\"input\\\":[1,1024,1024,3]}
Examples for two inputs:
If using the console, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}
If using the CLI, {\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}
KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {\"input_1\":[1,3,224,224]}
If using the CLI, {\\\"input_1\\\":[1,3,224,224]}
Examples for two inputs:
If using the console, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}
If using the CLI, {\\\"input_1\\\": [1,3,224,224], \\\"input_2\\\":[1,3,224,224]}
MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {\"data\":[1,3,1024,1024]}
If using the CLI, {\\\"data\\\":[1,3,1024,1024]}
Examples for two inputs:
If using the console, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}
If using the CLI, {\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}
PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.
Examples for one input in dictionary format:
If using the console, {\"input0\":[1,3,224,224]}
If using the CLI, {\\\"input0\\\":[1,3,224,224]}
Example for one input in list format: [[1,3,224,224]]
Examples for two inputs in dictionary format:
If using the console, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}
If using the CLI, {\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]}
Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]
XGBOOST: input data name and shape are not needed.
DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):
shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}
Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}
default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}
type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.
bias: If the input type is an Image, you need to provide the bias vector.
scale: If the input type is an Image, you need to provide a scale factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:
Tensor type input:
\"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3]}}
Tensor type input without input name (PyTorch):
\"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224]}]
Image type input:
\"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}
\"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}
Image type input without input name (PyTorch):
\"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]
\"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}
Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow's default signature def key. For example:
\"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}
\"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}
For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:
\"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}
\"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}
Identifies the framework in which the model was trained. For example:\n TENSORFLOW.
", + "smithy.api#documentation": "Identifies the framework in which the model was trained. For example: TENSORFLOW.
", "smithy.api#required": {} } }, "FrameworkVersion": { "target": "com.amazonaws.sagemaker#FrameworkVersion", "traits": { - "smithy.api#documentation": "Specifies the framework version to use. This API field is only supported for the\n MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
\nFor information about framework versions supported for cloud targets and edge devices,\n see Cloud\n Supported Instance Types and Frameworks and Edge Supported\n Frameworks.
" + "smithy.api#documentation": "Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.
For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the location of input model artifacts, the name and\n shape\n of the expected data inputs, and the framework in which the model was trained.
" + "smithy.api#documentation": "Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
" } }, "com.amazonaws.sagemaker#InputDataConfig": { @@ -36762,7 +36769,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines an instance group for heterogeneous cluster training. When requesting a\n training job using the CreateTrainingJob API, you can configure multiple instance groups .
" + "smithy.api#documentation": "Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .
" } }, "com.amazonaws.sagemaker#InstanceGroupName": { @@ -36862,7 +36869,7 @@ "target": "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Indicates the minimum IMDS version that the notebook instance supports. When passed as\n part of CreateNotebookInstance, if no value is selected, then it defaults\n to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of\n UpdateNotebookInstance, there is no default.
Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
The minimum\n value\n of the hyperparameter to search.
", + "smithy.api#documentation": "The minimum value of the hyperparameter to search.
", "smithy.api#required": {} } }, @@ -37934,19 +37941,19 @@ "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum\n value\n of the hyperparameter to search.
", + "smithy.api#documentation": "The maximum value of the hyperparameter to search.
", "smithy.api#required": {} } }, "ScalingType": { "target": "com.amazonaws.sagemaker#HyperParameterScalingType", "traits": { - "smithy.api#documentation": "The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
\nSageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.
\nLogarithmic scaling works only for ranges that have only values greater\n than 0.
\nThe scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have only values greater than 0.
For a hyperparameter of the integer type, specifies the range\n that\n a hyperparameter tuning job searches.
" + "smithy.api#documentation": "For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
" } }, "com.amazonaws.sagemaker#IntegerParameterRangeSpecification": { @@ -38186,13 +38193,13 @@ "EmrSettings": { "target": "com.amazonaws.sagemaker#EmrSettings", "traits": { - "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.
" + "smithy.api#documentation": "The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
" } }, "BuiltInLifecycleConfigArn": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
" } } }, @@ -38206,19 +38213,19 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the\n LifecycleConfigArns parameter, then this parameter is also required.
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\n JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is\n also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
A list of Git repositories that SageMaker AI automatically displays to users for\n cloning in the JupyterServer application.
" + "smithy.api#documentation": "A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
" } } }, @@ -38242,12 +38249,12 @@ "Status": { "target": "com.amazonaws.sagemaker#FeatureStatus", "traits": { - "smithy.api#documentation": "Describes whether the document querying feature is enabled\n or disabled in the Canvas application.
" + "smithy.api#documentation": "Describes whether the document querying feature is enabled or disabled in the Canvas application.
" } } }, "traits": { - "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure\n document querying.
" + "smithy.api#documentation": "The Amazon SageMaker Canvas application setting where you configure document querying.
" } }, "com.amazonaws.sagemaker#KernelDisplayName": { @@ -38265,19 +38272,19 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
\nThe Amazon SageMaker AI Studio UI does not use the default instance type value set\n here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not\n passed.
\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.
A list of custom SageMaker AI images that are configured to run as a KernelGateway\n app.
\nThe maximum number of custom images are as follows.
\nOn a domain level: 200
\nOn a space level: 5
\nOn a user profile level: 5
\nA list of custom SageMaker AI images that are configured to run as a KernelGateway app.
The maximum number of custom images are as follows.
On a domain level: 200
On a space level: 5
On a user profile level: 5
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\n profile or domain.
\nTo remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
The configuration for the file system and kernels in a SageMaker AI image running as a\n KernelGateway app.
" + "smithy.api#documentation": "The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app.
" } }, "com.amazonaws.sagemaker#KernelName": { @@ -38469,14 +38476,14 @@ "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:
\n\n Image classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n
\n Text classification\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n
\n Object detection\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n
\n Semantic Segmentation\n
\n\n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n
Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:
Image classification
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification
Text classification
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification
Object detection
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection
Semantic Segmentation
arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation
At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.
" + "smithy.api#documentation": "At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.
" } }, "LabelingJobResourceConfig": { @@ -38487,7 +38494,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides configuration information for auto-labeling of your data objects. A\n LabelingJobAlgorithmsConfig object must be supplied in order to use\n auto-labeling.
Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.
Declares that your content is free of personally identifiable information or adult\n content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.
" + "smithy.api#documentation": "Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
" } } }, "traits": { - "smithy.api#documentation": "Attributes of the data specified by the customer. Use these to describe the data to be\n labeled.
" + "smithy.api#documentation": "Attributes of the data specified by the customer. Use these to describe the data to be labeled.
" } }, "com.amazonaws.sagemaker#LabelingJobDataSource": { @@ -38531,7 +38538,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the location of input data.
\nYou must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
Provides information about the location of input data.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.
", + "smithy.api#documentation": "A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
", "smithy.api#required": {} } }, @@ -38555,7 +38562,7 @@ "target": "com.amazonaws.sagemaker#AccountId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Web Services account ID of the account used to start the labeling\n job.
", + "smithy.api#documentation": "The Amazon Web Services account ID of the account used to start the labeling job.
", "smithy.api#required": {} } }, @@ -38636,7 +38643,7 @@ "FinalActiveLearningModelArn": { "target": "com.amazonaws.sagemaker#ModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of\n automated data labeling.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.
" } } }, @@ -38658,13 +38665,13 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
\nIf you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.
\nIf you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.
\nIf you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n
The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.
If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.
If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.
If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling\n Job.
" + "smithy.api#documentation": "An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling Job.
" } } }, @@ -38678,7 +38685,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.
\nYou can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.
The VolumeKmsKeyId can be any of the following formats:
KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.
You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.
The VolumeKmsKeyId can be any of the following formats:
KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configure encryption on the storage volume attached to the ML compute instance used to\n run automated data labeling model training and inference.
" + "smithy.api#documentation": "Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.
" } }, "com.amazonaws.sagemaker#LabelingJobS3DataSource": { @@ -38696,7 +38703,7 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 location of the manifest file that describes the input data objects.
\nThe input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:
\n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.
\n source: The source of the object is the value. Use this\n value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.
", + "smithy.api#documentation": "The Amazon S3 location of the manifest file that describes the input data objects.
The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:
source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.
source: The source of the object is the value. Use this value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.
", "smithy.api#required": {} } } @@ -38712,7 +38719,7 @@ "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic\n you will use to send new data objects to a streaming labeling job.
", + "smithy.api#documentation": "The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
", "smithy.api#required": {} } } @@ -38779,7 +38786,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.
\nLabeling jobs fail after 30 days with an appropriate client error message.
\nA set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
Labeling jobs fail after 30 days with an appropriate client error message.
The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
", "smithy.api#required": {} } }, @@ -38844,19 +38851,19 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
" } }, "AnnotationConsolidationLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.
" } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "If the LabelingJobStatus field is Failed, this field\n contains a description of the error.
If the LabelingJobStatus field is Failed, this field contains a description of the error.
Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity \n resources.
" + "smithy.api#documentation": "Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.
" } }, "com.amazonaws.sagemaker#LineageType": { @@ -39165,7 +39172,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListActions didn't return the full set of actions,\n the call returns a token for getting the next set of actions.
If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.
A filter that returns only algorithms created after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only algorithms created after the specified time (timestamp).
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only algorithms created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only algorithms created before the specified time (timestamp).
" } }, "MaxResults": { @@ -39241,19 +39248,19 @@ "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListAlgorithms request was truncated, the\n response includes a NextToken. To retrieve the next set of algorithms, use\n the token in the next request.
If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The parameter by which to sort the results. The default is CreationTime.
>An array of AlgorithmSummary objects, each of which lists an\n algorithm.
>An array of AlgorithmSummary objects, each of which lists an algorithm.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
" } } }, @@ -39344,7 +39351,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListAliases didn't return the full set of\n aliases, the call returns a token for retrieving the next set of aliases.
If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.
Lists the AppImageConfigs in your account and their properties. The list can be\n filtered by creation time or modified time, and whether the AppImageConfig name contains\n a specified string.
", + "smithy.api#documentation": "Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -39396,13 +39403,13 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.
If the previous call to ListImages didn't return the full set of\n AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
A parameter to search by user profile name. If SpaceNameEquals is set, then\n this value cannot be set.
A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then\n this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -39625,7 +39632,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListArtifacts didn't return the full set of artifacts,\n the call returns a token for getting the next set of artifacts.
If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.
If the previous call to ListAssociations didn't return the full set of associations,\n the call returns a token for getting the next set of associations.
If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.
If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -39876,7 +39883,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -39939,7 +39946,7 @@ "SortBy": { "target": "com.amazonaws.sagemaker#CandidateSortBy", "traits": { - "smithy.api#documentation": "The parameter by which to sort the results. The default is\n Descending.
The parameter by which to sort the results. The default is Descending.
If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -39973,7 +39980,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -39995,7 +40002,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the list of instances (also called nodes interchangeably)\n in a SageMaker HyperPod cluster.
", + "smithy.api#documentation": "Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -40011,20 +40018,20 @@ "target": "com.amazonaws.sagemaker#ClusterNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the\n list of nodes.
", + "smithy.api#documentation": "The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
", "smithy.api#required": {} } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00
YYYY-MM-DD, for example, 2014-10-01
Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
If the result of the previous ListClusterNodes request was truncated, the\n response includes a NextToken. To retrieve the next set of cluster nodes, use\n the token in the next request.
If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
The field by which to sort results. The default value is\n CREATION_TIME.
The field by which to sort results. The default value is CREATION_TIME.
Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
" } }, "CreatedBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
" } }, "NameContains": { @@ -40138,19 +40145,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#SortClusterSchedulerConfigBy", "traits": { - "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
" } }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { @@ -40176,7 +40183,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -40208,13 +40215,13 @@ "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Set a start time for the time range during which you want to list SageMaker HyperPod clusters.\n Timestamps are formatted according to the ISO 8601 standard.
\nAcceptable formats include:
\n\n YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,\n 2014-10-01T20:30:00.000Z\n
\n YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,\n 2014-10-01T12:30:00.000-08:00\n
\n YYYY-MM-DD, for example, 2014-10-01\n
Unix time in seconds, for example, 1412195400. This is also referred\n to as Unix Epoch time and represents the number of seconds since midnight, January 1,\n 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
" + "smithy.api#documentation": "Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00
YYYY-MM-DD, for example, 2014-10-01
Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A\n filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The\n acceptable formats are the same as the timestamp formats for\n CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User\n Guide.
Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
The field by which to sort results. The default value is\n CREATION_TIME.
The field by which to sort results. The default value is CREATION_TIME.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about\n reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
If the result of the previous ListClusters request was truncated, the\n response includes a NextToken. To retrieve the next set of clusters, use the\n token in the next request.
If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.
A filter that returns only Git repositories that were created after the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Git repositories that were created after the specified time.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were created before the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Git repositories that were created before the specified time.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were last modified after the\n specified time.
" + "smithy.api#documentation": "A filter that returns only Git repositories that were last modified after the specified time.
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Git repositories that were last modified before the\n specified time.
" + "smithy.api#documentation": "A filter that returns only Git repositories that were last modified before the specified time.
" } }, "MaxResults": { @@ -40334,13 +40341,13 @@ "NameContains": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", "traits": { - "smithy.api#documentation": "A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.
" + "smithy.api#documentation": "A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.
Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:
\nName
\nAmazon Resource Name (ARN)
\nCreation time
\nLast modified time
\nConfiguration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.
\nGets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:
Name
Amazon Resource Name (ARN)
Creation time
Last modified time
Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.
If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.
If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.
Lists model compilation jobs that satisfy various filters.
\nTo create a model compilation job, use CreateCompilationJob. To get information about a particular model\n compilation job you have created, use DescribeCompilationJob.
", + "smithy.api#documentation": "Lists model compilation jobs that satisfy various filters.
To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -40406,7 +40413,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.
A filter that returns the model compilation jobs that were created after a specified\n time.
" + "smithy.api#documentation": "A filter that returns the model compilation jobs that were created after a specified time.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were created before a specified\n time.
" + "smithy.api#documentation": "A filter that returns the model compilation jobs that were created before a specified time.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified after a specified\n time.
" + "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified after a specified time.
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified before a specified\n time.
" + "smithy.api#documentation": "A filter that returns the model compilation jobs that were modified before a specified time.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A filter that returns the model compilation jobs whose name contains a specified\n string.
" + "smithy.api#documentation": "A filter that returns the model compilation jobs whose name contains a specified string.
" } }, "StatusEquals": { "target": "com.amazonaws.sagemaker#CompilationJobStatus", "traits": { - "smithy.api#documentation": "A filter that retrieves model compilation jobs with a specific\n CompilationJobStatus status.
A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.
An array of CompilationJobSummary objects, each describing a model compilation job.\n
", + "smithy.api#documentation": "An array of CompilationJobSummary objects, each describing a model compilation job.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve\n the next set of model compilation jobs, use this token in the next request.
If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
Filter for after this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + "smithy.api#documentation": "Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
" } }, "CreatedBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp.\n To convert a date and time into a Unix timestamp, see EpochConverter.
" + "smithy.api#documentation": "Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
" } }, "NameContains": { @@ -40567,19 +40574,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#SortQuotaBy", "traits": { - "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time,\n or status.
" + "smithy.api#documentation": "Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
" } }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "The order of the list. By default, listed in Descending order according to\n by SortBy. To change the list order, you can specify SortOrder to\n be Ascending.
The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { @@ -40605,7 +40612,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -40678,7 +40685,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListContexts didn't return the full set of contexts,\n the call returns a token for getting the next set of contexts.
If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
A filter that lists the data quality job definitions associated with the specified\n endpoint.
" + "smithy.api#documentation": "A filter that lists the data quality job definitions associated with the specified endpoint.
" } }, "SortBy": { @@ -40748,37 +40755,37 @@ "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n transform jobs, use the token in the next request.>
If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>
The maximum number of data quality monitoring job definitions to return in the\n response.
" + "smithy.api#documentation": "The maximum number of data quality monitoring job definitions to return in the response.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the data quality monitoring job definition name. This filter returns only\n data quality monitoring job definitions whose name contains the specified string.
" + "smithy.api#documentation": "A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created before the\n specified time.
" + "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created before the specified time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created after the\n specified time.
" + "smithy.api#documentation": "A filter that returns only data quality monitoring job definitions created after the specified time.
" } } }, @@ -40800,7 +40807,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListDataQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of data\n quality monitoring job definitions, use the token in the next request.
If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -41093,7 +41100,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to need\n tokening.
" + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" } }, "MaxResults": { @@ -41141,7 +41148,7 @@ "SortBy": { "target": "com.amazonaws.sagemaker#ListEdgeDeploymentPlansSortBy", "traits": { - "smithy.api#documentation": "The column by which to sort the edge deployment plans. Can be one of\n NAME, DEVICEFLEETNAME, CREATIONTIME,\n LASTMODIFIEDTIME.
The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.
If the result of the previous ListEndpointConfig request was\n truncated, the response includes a NextToken. To retrieve the next set of\n endpoint configurations, use the token in the next request.
If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.
A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.
" + "smithy.api#documentation": "A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoint configurations created before the specified\n time (timestamp).
" + "smithy.api#documentation": "A filter that returns only endpoint configurations created before the specified time (timestamp).
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
" } } }, @@ -41437,7 +41444,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
" } } }, @@ -41481,43 +41488,43 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "If the result of a ListEndpoints request was truncated, the response\n includes a NextToken. To retrieve the next set of endpoints, use the token\n in the next request.
If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.
The maximum number of endpoints to return in the response. This value defaults to\n 10.
" + "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to 10.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#EndpointNameContains", "traits": { - "smithy.api#documentation": "A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.
" + "smithy.api#documentation": "A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only endpoints that were created before the specified time (timestamp).
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were modified before the specified\n timestamp.
" + "smithy.api#documentation": "A filter that returns only endpoints that were modified before the specified timestamp.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only endpoints that were modified after the specified\n timestamp.
" + "smithy.api#documentation": "A filter that returns only endpoints that were modified after the specified timestamp.
" } }, "StatusEquals": { @@ -41545,7 +41552,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
" } } }, @@ -41562,7 +41569,7 @@ "target": "com.amazonaws.sagemaker#ListExperimentsResponse" }, "traits": { - "smithy.api#documentation": "Lists all the experiments in your account. The list can be filtered to show only\n experiments that were created in a specific time range. The list can be sorted by experiment\n name or creation time.
", + "smithy.api#documentation": "Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -41601,13 +41608,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.
If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.
The maximum number of experiments to return in the response. The default value is\n 10.
" + "smithy.api#documentation": "The maximum number of experiments to return in the response. The default value is 10.
" } } }, @@ -41659,7 +41666,7 @@ "NameContains": { "target": "com.amazonaws.sagemaker#FeatureGroupNameContains", "traits": { - "smithy.api#documentation": "A string that partially matches one or more FeatureGroups names. Filters\n FeatureGroups by name.
A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
An OfflineStore status. Filters by OfflineStore status.\n
An OfflineStore status. Filters by OfflineStore status.
Use this parameter to search for FeatureGroupss created after a specific\n date and time.
Use this parameter to search for FeatureGroupss created after a specific date and time.
Use this parameter to search for FeatureGroupss created before a specific\n date and time.
Use this parameter to search for FeatureGroupss created before a specific date and time.
Gets a list of HyperParameterTuningJobSummary objects that\n describe\n the hyperparameter tuning jobs launched in your account.
", + "smithy.api#documentation": "Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42243,13 +42250,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.
If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
The\n maximum number of tuning jobs to return. The default value is\n 10.
" + "smithy.api#documentation": "The maximum number of tuning jobs to return. The default value is 10.
" } }, "SortBy": { @@ -42267,31 +42274,31 @@ "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were created after the specified\n time.
" + "smithy.api#documentation": "A filter that returns only tuning jobs that were created after the specified time.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were created before the specified\n time.
" + "smithy.api#documentation": "A filter that returns only tuning jobs that were created before the specified time.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were modified after the specified\n time.
" + "smithy.api#documentation": "A filter that returns only tuning jobs that were modified after the specified time.
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only tuning jobs that were modified before the specified\n time.
" + "smithy.api#documentation": "A filter that returns only tuning jobs that were modified before the specified time.
" } }, "StatusEquals": { @@ -42312,14 +42319,14 @@ "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSummaries", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of HyperParameterTuningJobSummary objects that\n describe\n the tuning jobs that the ListHyperParameterTuningJobs\n request returned.
A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
If the result of this ListHyperParameterTuningJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of tuning jobs,\n use the token in the next request.
If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
Lists the versions of a specified image and their properties. The list can be filtered\n by creation time or modified time.
", + "smithy.api#documentation": "Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42394,7 +42401,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListImageVersions didn't return the full set of\n versions, the call returns a token for getting the next set of versions.
If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.
Lists the images in your account and their properties. The list can be filtered by\n creation time or modified time, and whether the image name contains a specified string.
", + "smithy.api#documentation": "Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42494,7 +42501,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListImages didn't return the full set of images,\n the call returns a token for getting the next set of images.
If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
The field by which to sort the inference components in the response. The default is\n CreationTime.
The field by which to sort the inference components in the response. The default is CreationTime.
A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" + "smithy.api#documentation": "A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of inference components to return in the response. This value\n defaults to 10.
" + "smithy.api#documentation": "The maximum number of inference components to return in the response. This value defaults to 10.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#InferenceComponentNameContains", "traits": { - "smithy.api#documentation": "Filters the results to only those inference components with a name that contains the\n specified string.
" + "smithy.api#documentation": "Filters the results to only those inference components with a name that contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were created before the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those inference components that were created before the specified time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were created after the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those inference components that were created after the specified time.
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were updated before the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those inference components that were updated before the specified time.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Filters the results to only those inference components that were updated after the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those inference components that were updated after the specified time.
" } }, "StatusEquals": { @@ -42618,13 +42625,13 @@ "EndpointNameEquals": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "An endpoint name to filter the listed inference components. The response includes only\n those inference components that are hosted at the specified endpoint.
" + "smithy.api#documentation": "An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.
" } }, "VariantNameEquals": { "target": "com.amazonaws.sagemaker#VariantName", "traits": { - "smithy.api#documentation": "A production variant name to filter the listed inference components. The response\n includes only those inference components that are hosted at the specified variant.
" + "smithy.api#documentation": "A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.
" } } }, @@ -42639,14 +42646,14 @@ "target": "com.amazonaws.sagemaker#InferenceComponentSummaryList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of inference components and their properties that matches any of the filters you\n specified in the request.
", + "smithy.api#documentation": "A list of inference components and their properties that matches any of the filters you specified in the request.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a truncated response.
" } } }, @@ -42684,13 +42691,13 @@ "Type": { "target": "com.amazonaws.sagemaker#InferenceExperimentType", "traits": { - "smithy.api#documentation": "\n Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.\n
" + "smithy.api#documentation": "Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
" } }, "StatusEquals": { "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", "traits": { - "smithy.api#documentation": "\n Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.\n
" + "smithy.api#documentation": "Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
" } }, "CreationTimeAfter": { @@ -42732,7 +42739,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "\n The response from the last list when returning a list large enough to need tokening.\n
" + "smithy.api#documentation": "The response from the last list when returning a list large enough to need tokening.
" } }, "MaxResults": { @@ -42780,7 +42787,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of the subtasks for an Inference Recommender job.
\nThe supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
", + "smithy.api#documentation": "Returns a list of the subtasks for an Inference Recommender job.
The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42809,7 +42816,7 @@ "StepType": { "target": "com.amazonaws.sagemaker#RecommendationStepType", "traits": { - "smithy.api#documentation": "A filter to return details about the specified type of subtask.
\n\n BENCHMARK: Evaluate the performance of your model on different instance types.
A filter to return details about the specified type of subtask.
BENCHMARK: Evaluate the performance of your model on different instance types.
If the response to a previous ListInferenceRecommendationsJobsRequest request \n was truncated, the response includes a NextToken. To retrieve the next set \n of recommendations, use the token in the next request.
If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.
The Amazon Resource Name (ARN) of the work team for which you want to see labeling\n jobs for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
", "smithy.api#required": {} } }, @@ -43053,25 +43060,25 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
A filter that returns only labeling jobs created after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs created after the specified time (timestamp).
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time (timestamp).
" } }, "JobReferenceCodeContains": { "target": "com.amazonaws.sagemaker#JobReferenceCodeContains", "traits": { - "smithy.api#documentation": "A filter the limits jobs to only the ones whose job reference code contains the\n specified string.
" + "smithy.api#documentation": "A filter the limits jobs to only the ones whose job reference code contains the specified string.
" } }, "SortBy": { @@ -43098,14 +43105,14 @@ "target": "com.amazonaws.sagemaker#LabelingJobForWorkteamSummaryList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of LabelingJobSummary objects, each describing a labeling\n job.
An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
" } } }, @@ -43130,25 +43137,25 @@ "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs created after the specified time (timestamp).
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs created before the specified time (timestamp).
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs modified after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs modified after the specified time (timestamp).
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only labeling jobs modified before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only labeling jobs modified before the specified time (timestamp).
" } }, "MaxResults": { @@ -43160,13 +43167,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
" } }, "SortBy": { @@ -43198,13 +43205,13 @@ "LabelingJobSummaryList": { "target": "com.amazonaws.sagemaker#LabelingJobSummaryList", "traits": { - "smithy.api#documentation": "An array of LabelingJobSummary objects, each describing a labeling\n job.
An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
" } } }, @@ -43227,7 +43234,7 @@ "target": "com.amazonaws.sagemaker#ListLineageGroupsResponse" }, "traits": { - "smithy.api#documentation": "A list of lineage groups shared with your Amazon Web Services account. \n For more information, see \n Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
", + "smithy.api#documentation": "A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -43254,7 +43261,7 @@ "SortBy": { "target": "com.amazonaws.sagemaker#SortLineageGroupsBy", "traits": { - "smithy.api#documentation": "The parameter by which to sort the results. The default is\n CreationTime.
The parameter by which to sort the results. The default is CreationTime.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to\n 10.
" + "smithy.api#documentation": "The maximum number of endpoints to return in the response. This value defaults to 10.
" } } }, @@ -43292,7 +43299,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
" } } }, @@ -43332,13 +43339,13 @@ "CreatedAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Use the CreatedAfter filter to only list tracking servers created after a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a\n Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a\n specific date and time. Listed tracking servers are shown with a date and time such as\n \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in\n a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. \n To change the list order, you can specify SortOrder to be Ascending.
Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. To change the list order, you can specify SortOrder to be Ascending.
Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of model bias jobs to return in the response. The default value is\n 10.
" + "smithy.api#documentation": "The maximum number of model bias jobs to return in the response. The default value is 10.
" } }, "NameContains": { @@ -43490,7 +43497,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } } }, @@ -43572,7 +43579,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCardExportJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model card export jobs, use the token in the next request.
If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card export jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.
" } } }, @@ -43669,7 +43676,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCardVersions request was truncated,\n the response includes a NextToken. To retrieve the next set of model card\n versions, use the token in the next request.
If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n card versions, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.
" } } }, @@ -43765,7 +43772,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListModelCards request was truncated, the\n response includes a NextToken. To retrieve the next set of model cards, use\n the token in the next request.
If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model\n cards, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.
" } } }, @@ -43837,19 +43844,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionSortKey", "traits": { - "smithy.api#documentation": "Whether to sort results by the Name or CreationTime field. \n The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } }, "MaxResults": { @@ -43867,13 +43874,13 @@ "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only model explainability jobs created before a specified\n time.
" + "smithy.api#documentation": "A filter that returns only model explainability jobs created before a specified time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only model explainability jobs created after a specified\n time.
" + "smithy.api#documentation": "A filter that returns only model explainability jobs created after a specified time.
" } } }, @@ -43895,7 +43902,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } } }, @@ -43912,7 +43919,7 @@ "target": "com.amazonaws.sagemaker#ListModelMetadataResponse" }, "traits": { - "smithy.api#documentation": "Lists the domain, framework, task, and model name of standard \n machine learning models found in common model zoos.
", + "smithy.api#documentation": "Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -43927,13 +43934,13 @@ "SearchExpression": { "target": "com.amazonaws.sagemaker#ModelMetadataSearchExpression", "traits": { - "smithy.api#documentation": "One or more filters that searches for the specified resource or resources \n in a search. All resource objects that satisfy the expression's condition are \n included in the search results. Specify the Framework, FrameworkVersion, Domain \n or Task to filter supported. Filter names and values are case-sensitive.
" + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListModelMetadataResponse request was truncated, \n the response includes a NextToken. To retrieve the next set of model metadata, \n use the token in the next request.
If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.
A string in the model group name. This filter returns only model groups whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the model group name. This filter returns only model groups whose name contains the specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListModelPackageGroups request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model groups, use the token in the next request.
If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.
A filter that returns either model groups shared with you or model groups in your own\n account. When the value is CrossAccount, the results show the resources\n made discoverable to you from other accounts. When the value is SameAccount\n or null, the results show resources from your account. The default is\n SameAccount.
A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model groups, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
" } } }, @@ -44089,13 +44096,13 @@ "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only model packages created after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only model packages created after the specified time (timestamp).
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only model packages created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only model packages created before the specified time (timestamp).
" } }, "MaxResults": { @@ -44107,37 +44114,37 @@ "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the model package name. This filter returns only model packages whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the model package name. This filter returns only model packages whose name contains the specified string.
" } }, "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "A filter that returns only the model packages with the specified approval\n status.
" + "smithy.api#documentation": "A filter that returns only the model packages with the specified approval status.
" } }, "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model\n group.
" + "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model group.
" } }, "ModelPackageType": { "target": "com.amazonaws.sagemaker#ModelPackageType", "traits": { - "smithy.api#documentation": "A filter that returns only the model packages of the specified type. This can be one\n of the following values.
\n\n UNVERSIONED - List only unversioined models. This is the default\n value if no ModelPackageType is specified.
\n VERSIONED - List only versioned models.
\n BOTH - List both versioned and unversioned models.
A filter that returns only the model packages of the specified type. This can be one of the following values.
UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
VERSIONED - List only versioned models.
BOTH - List both versioned and unversioned models.
If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.
If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.
The parameter by which to sort the results. The default is\n CreationTime.
The parameter by which to sort the results. The default is CreationTime.
An array of ModelPackageSummary objects, each of which lists a model\n package.
An array of ModelPackageSummary objects, each of which lists a model package.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
" } } }, @@ -44197,7 +44204,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions that are associated\n with the specified endpoint.
" + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
" } }, "SortBy": { @@ -44209,37 +44216,37 @@ "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
If the result of the previous ListModelQualityJobDefinitions request was\n truncated, the response includes a NextToken. To retrieve the next set of\n model quality monitoring job definitions, use the token in the next request.
If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.
The maximum number of results to return in a call to\n ListModelQualityJobDefinitions.
The maximum number of results to return in a call to ListModelQualityJobDefinitions.
A string in the transform job name. This filter returns only model quality monitoring\n job definitions whose name contains the specified string.
" + "smithy.api#documentation": "A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created before the\n specified time.
" + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created before the specified time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created after the\n specified time.
" + "smithy.api#documentation": "A filter that returns only model quality monitoring job definitions created after the specified time.
" } } }, @@ -44261,7 +44268,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the\n next set of model quality monitoring job definitions, use it in the next request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
" } } }, @@ -44305,7 +44312,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.
If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
A string in the model name. This filter returns only models whose name contains the\n specified string.
" + "smithy.api#documentation": "A string in the model name. This filter returns only models whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only models created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only models created before the specified time (timestamp).
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
" } } }, @@ -44344,14 +44351,14 @@ "target": "com.amazonaws.sagemaker#ModelSummaryList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ModelSummary objects, each of which lists a\n model.
An array of ModelSummary objects, each of which lists a model.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
" } } }, @@ -44406,13 +44413,13 @@ "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "The sort order, whether Ascending or Descending, of the alert\n history. The default is Descending.
The sort order, whether Ascending or Descending, of the alert history. The default is Descending.
If the result of the previous ListMonitoringAlertHistory request was\n truncated, the response includes a NextToken. To retrieve the next set of\n alerts in the history, use the token in the next request.
If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
" } } }, @@ -44501,7 +44508,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListMonitoringAlerts request was truncated,\n the response includes a NextToken. To retrieve the next set of alerts in the\n history, use the token in the next request.
If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n alerts, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
" } } }, @@ -44571,19 +44578,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", "traits": { - "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } }, "MaxResults": { @@ -44637,13 +44644,13 @@ "MonitoringJobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "Gets a list of the monitoring job runs of the specified monitoring job\n definitions.
" + "smithy.api#documentation": "Gets a list of the monitoring job runs of the specified monitoring job definitions.
" } }, "MonitoringTypeEquals": { "target": "com.amazonaws.sagemaker#MonitoringType", "traits": { - "smithy.api#documentation": "A filter that returns only the monitoring job runs of the specified monitoring\n type.
" + "smithy.api#documentation": "A filter that returns only the monitoring job runs of the specified monitoring type.
" } } }, @@ -44665,7 +44672,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } } }, @@ -44703,19 +44710,19 @@ "SortBy": { "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", "traits": { - "smithy.api#documentation": "Whether to sort the results by the Status, CreationTime, or \n ScheduledTime field. The default is CreationTime.
Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. \n The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } }, "MaxResults": { @@ -44763,13 +44770,13 @@ "MonitoringJobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "Gets a list of the monitoring schedules for the specified monitoring job\n definition.
" + "smithy.api#documentation": "Gets a list of the monitoring schedules for the specified monitoring job definition.
" } }, "MonitoringTypeEquals": { "target": "com.amazonaws.sagemaker#MonitoringType", "traits": { - "smithy.api#documentation": "A filter that returns only the monitoring schedules for the specified monitoring\n type.
" + "smithy.api#documentation": "A filter that returns only the monitoring schedules for the specified monitoring type.
" } } }, @@ -44791,7 +44798,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use \n it in the next request.
" + "smithy.api#documentation": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" } } }, @@ -44823,7 +44830,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of a ListNotebookInstanceLifecycleConfigs request was\n truncated, the response includes a NextToken. To get the next set of\n lifecycle configurations, use the token in the next request.
If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.
A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.
" + "smithy.api#documentation": "A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
" } } }, @@ -44885,13 +44892,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, SageMaker AI returns this token. To get the next\n set of lifecycle configurations, use it in the next request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request.
" } }, "NotebookInstanceLifecycleConfigs": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummaryList", "traits": { - "smithy.api#documentation": "An array of NotebookInstanceLifecycleConfiguration objects, each listing\n a lifecycle configuration.
An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
Returns a list of the SageMaker AI notebook instances in the requester's\n account in an Amazon Web Services Region.
", + "smithy.api#documentation": "Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -44923,7 +44930,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": " If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.
You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.
\n If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.
You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.
" + "smithy.api#documentation": "A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were created before the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only notebook instances that were created before the specified time (timestamp).
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were created after the specified\n time (timestamp).
" + "smithy.api#documentation": "A filter that returns only notebook instances that were created after the specified time (timestamp).
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were modified before the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only notebook instances that were modified before the specified time (timestamp).
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances that were modified after the\n specified time (timestamp).
" + "smithy.api#documentation": "A filter that returns only notebook instances that were modified after the specified time (timestamp).
" } }, "StatusEquals": { @@ -44983,19 +44990,19 @@ "NotebookInstanceLifecycleConfigNameContains": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "A string in the name of a notebook instances lifecycle configuration associated with\n this notebook instance. This filter returns only notebook instances associated with a\n lifecycle configuration with a name that contains the specified string.
" + "smithy.api#documentation": "A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
" } }, "DefaultCodeRepositoryContains": { "target": "com.amazonaws.sagemaker#CodeRepositoryContains", "traits": { - "smithy.api#documentation": "A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.
" + "smithy.api#documentation": "A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.
" } }, "AdditionalCodeRepositoryEquals": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "A filter that returns only notebook instances with associated with the specified git\n repository.
" + "smithy.api#documentation": "A filter that returns only notebook instances with associated with the specified git repository.
" } } }, @@ -45009,13 +45016,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the response to the previous ListNotebookInstances request was\n truncated, SageMaker AI returns this token. To retrieve the next set of notebook\n instances, use the token in the next request.
If the response to the previous ListNotebookInstances request was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request.
An array of NotebookInstanceSummary objects, one for each notebook\n instance.
An array of NotebookInstanceSummary objects, one for each notebook instance.
A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" + "smithy.api#documentation": "A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of optimization jobs to return in the response. The default is\n 50.
" + "smithy.api#documentation": "The maximum number of optimization jobs to return in the response. The default is 50.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were created after the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created after the specified time.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were created before the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created before the specified time.
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated after the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated after the specified time.
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated before the\n specified time.
" + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated before the specified time.
" } }, "OptimizationContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "Filters the results to only those optimization jobs that apply the specified\n optimization techniques. You can specify either Quantization or\n Compilation.
Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.
Filters the results to only those optimization jobs with a name that contains the\n specified string.
" + "smithy.api#documentation": "Filters the results to only those optimization jobs with a name that contains the specified string.
" } }, "StatusEquals": { @@ -45101,13 +45108,13 @@ "SortBy": { "target": "com.amazonaws.sagemaker#ListOptimizationJobsSortBy", "traits": { - "smithy.api#documentation": "The field by which to sort the optimization jobs in the response. The default is\n CreationTime\n
The field by which to sort the optimization jobs in the response. The default is CreationTime
The sort order for results. The default is Ascending\n
The sort order for results. The default is Ascending
A list of optimization jobs and their properties that matches any of the filters you\n specified in the request.
", + "smithy.api#documentation": "A list of optimization jobs and their properties that matches any of the filters you specified in the request.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a truncated response.
" } } }, @@ -45184,13 +45191,13 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be returned in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -45210,7 +45217,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -45253,7 +45260,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
A list of PipeLineExecutionStep objects. Each\n PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus,\n and Metadata. Metadata is an object with properties for each job that contains relevant\n information about the job created by the step.
A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.
If the result of the previous ListPipelineExecutionSteps request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
A filter that returns the pipeline executions that were created after a specified\n time.
" + "smithy.api#documentation": "A filter that returns the pipeline executions that were created after a specified time.
" } }, "CreatedBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns the pipeline executions that were created before a specified\n time.
" + "smithy.api#documentation": "A filter that returns the pipeline executions that were created before a specified time.
" } }, "SortBy": { @@ -45354,7 +45361,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
Contains a sorted list of pipeline execution summary objects matching the specified\n filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date,\n and the status. This list can be empty.
" + "smithy.api#documentation": "Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelineExecutions request was truncated,\n the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
If the result of the previous ListPipelineParametersForExecution request was truncated,\n the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
A filter that returns the pipelines that were created after a specified\n time.
" + "smithy.api#documentation": "A filter that returns the pipelines that were created after a specified time.
" } }, "CreatedBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns the pipelines that were created before a specified\n time.
" + "smithy.api#documentation": "A filter that returns the pipelines that were created before a specified time.
" } }, "SortBy": { @@ -45513,7 +45520,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
Contains a sorted list of PipelineSummary objects matching the specified\n filters. Each PipelineSummary consists of PipelineArn, PipelineName,\n ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and\n RoleArn. This list can be empty.
Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.
If the result of the previous ListPipelines request was truncated,\n the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.
" + "smithy.api#documentation": "A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
" } }, "StatusEquals": { @@ -45619,7 +45626,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.
If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.
An array of ProcessingJobSummary objects, each listing a processing\n job.
An array of ProcessingJobSummary objects, each listing a processing job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n processing jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
" } } }, @@ -45678,13 +45685,13 @@ "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns the projects that were created after a specified\n time.
" + "smithy.api#documentation": "A filter that returns the projects that were created after a specified time.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns the projects that were created before a specified\n time.
" + "smithy.api#documentation": "A filter that returns the projects that were created before a specified time.
" } }, "MaxResults": { @@ -45696,13 +45703,13 @@ "NameContains": { "target": "com.amazonaws.sagemaker#ProjectEntityName", "traits": { - "smithy.api#documentation": "A filter that returns the projects whose name contains a specified\n string.
" + "smithy.api#documentation": "A filter that returns the projects whose name contains a specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListProjects request was truncated,\n the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.
If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of\n ResourceCatalogs viewable is 1000.
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.
A string that partially matches one or more ResourceCatalogs names.\n Filters ResourceCatalog by name.
A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.
Use this parameter to search for ResourceCatalogs created after a\n specific date and time.
Use this parameter to search for ResourceCatalogs created after a specific date and time.
Use this parameter to search for ResourceCatalogs created before a\n specific date and time.
Use this parameter to search for ResourceCatalogs created before a specific date and time.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
The parameter by which to sort the results. The default is\n CreationTime.
The parameter by which to sort the results. The default is CreationTime.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -45923,7 +45930,7 @@ "target": "com.amazonaws.sagemaker#ListStageDevicesResponse" }, "traits": { - "smithy.api#documentation": "Lists devices allocated to the stage, containing detailed device information and\n deployment status.
", + "smithy.api#documentation": "Lists devices allocated to the stage, containing detailed device information and deployment status.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -45938,7 +45945,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "The response from the last list when returning a list large enough to neeed\n tokening.
" + "smithy.api#documentation": "The response from the last list when returning a list large enough to neeed tokening.
" } }, "MaxResults": { @@ -46010,7 +46017,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services\n Account.
", + "smithy.api#documentation": "Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -46025,49 +46032,49 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The total number of items to return in the response. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n response. To resume pagination, provide the NextToken value in the as part of a\n subsequent call. The default value is 10.
The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.
If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle\n Configurations, the call returns a token for getting the next set of Lifecycle\n Configurations.
" + "smithy.api#documentation": "If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle\n Configurations whose name contains the specified string.
" + "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
" } }, "AppTypeEquals": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", "traits": { - "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is\n attached.
" + "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is attached.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified time.
" } }, "ModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified time.
" } }, "ModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified\n time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified time.
" } }, "SortBy": { @@ -46093,7 +46100,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "StudioLifecycleConfigs": { @@ -46116,7 +46123,7 @@ "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse" }, "traits": { - "smithy.api#documentation": "Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.
Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
A string in the work team name. This filter returns only work teams whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the work team name. This filter returns only work teams whose name contains the specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListSubscribedWorkteams request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.
If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
" } } }, @@ -46198,14 +46205,14 @@ "target": "com.amazonaws.sagemaker#ResourceArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": " If the response to the previous ListTags request is truncated, SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n
If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.
If response is truncated, SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.
" + "smithy.api#documentation": "If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.
" } } }, @@ -46256,7 +46263,7 @@ "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" }, "traits": { - "smithy.api#documentation": "Lists training jobs.
\nWhen StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following\n parameters:
\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n
First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI\n code.
\n\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n
Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }
First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
Gets a list of TrainingJobSummary objects that describe the training jobs that a\n hyperparameter tuning job launched.
", + "smithy.api#documentation": "Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -46302,7 +46309,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.
If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.
The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
A list of TrainingJobSummary objects that\n describe\n the training jobs that the\n ListTrainingJobsForHyperParameterTuningJob request returned.
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.
If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
If the result of the previous ListTrainingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of training\n jobs, use the token in the next request.
If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
A filter that returns only training jobs created after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only training jobs created after the specified time (timestamp).
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only training jobs created before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only training jobs created before the specified time (timestamp).
" } }, "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only training jobs modified after the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only training jobs modified after the specified time (timestamp).
" } }, "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only training jobs modified before the specified time\n (timestamp).
" + "smithy.api#documentation": "A filter that returns only training jobs modified before the specified time (timestamp).
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.
" + "smithy.api#documentation": "A string in the training job name. This filter returns only training jobs whose name contains the specified string.
" } }, "StatusEquals": { @@ -46428,7 +46435,7 @@ "TrainingPlanArnEquals": { "target": "com.amazonaws.sagemaker#TrainingPlanArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information\n about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see CreateTrainingPlan .
An array of TrainingJobSummary objects, each listing a training\n job.
An array of TrainingJobSummary objects, each listing a training job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
" } } }, @@ -46596,7 +46603,7 @@ "NameContains": { "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
" } }, "StatusEquals": { @@ -46620,7 +46627,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.
If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.
An array of\n TransformJobSummary\n objects.
An array of TransformJobSummary objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n transform jobs, use it in the next request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
" } } }, @@ -46676,7 +46683,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the trial components in your account. You can sort the list by trial component name\n or creation time. You can filter the list to show only components that were created in a\n specific time range. You can also filter on one of the following:
\n\n ExperimentName\n
\n SourceArn\n
\n TrialName\n
Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:
ExperimentName
SourceArn
TrialName
A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.
A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.
A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.
A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.
A filter that returns only components that have the specified source Amazon Resource Name (ARN). \n If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.
A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.
The maximum number of components to return in the response. The default value is\n 10.
" + "smithy.api#documentation": "The maximum number of components to return in the response. The default value is 10.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.
If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.
Lists the trials in your account. Specify an experiment name to limit the list to the\n trials that are part of that experiment. Specify a trial component name to limit the list to\n the trials that associated with that trial component. The list can be filtered to show only\n trials that were created in a specific time range. The list can be sorted by trial name or\n creation time.
", + "smithy.api#documentation": "Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -46802,7 +46809,7 @@ "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "A filter that returns only trials that are associated with the specified trial\n component.
" + "smithy.api#documentation": "A filter that returns only trials that are associated with the specified trial component.
" } }, "CreatedAfter": { @@ -46838,7 +46845,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.
If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, @@ -46957,7 +46964,7 @@ "target": "com.amazonaws.sagemaker#ListWorkforcesResponse" }, "traits": { - "smithy.api#documentation": "Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only \n have one private workforce per Amazon Web Services Region.
", + "smithy.api#documentation": "Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -47052,7 +47059,7 @@ "target": "com.amazonaws.sagemaker#ListWorkteamsResponse" }, "traits": { - "smithy.api#documentation": "Gets a list of private work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.
Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.
" + "smithy.api#documentation": "A string in the work team's name. This filter returns only work teams whose name contains the specified string.
" } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.
If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n work teams, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
" } } }, @@ -47383,7 +47390,7 @@ "OidcMemberDefinition": { "target": "com.amazonaws.sagemaker#OidcMemberDefinition", "traits": { - "smithy.api#documentation": "A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
The name of the standard metric.
\nFor definitions of the standard metrics, see \n Autopilot candidate metrics\n .
The name of the standard metric.
For definitions of the standard metrics, see Autopilot candidate metrics .
A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining metrics and environment variables.
", + "smithy.api#documentation": "A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies a metric that the training algorithm writes to stderr or\n stdout. You can view these logs to understand how your training job\n performs and check for any errors encountered during training. SageMaker hyperparameter\n tuning captures all defined metrics. Specify one of the defined metrics to use as an\n objective metric using the TuningObjective parameter in the\n HyperParameterTrainingJobDefinition API to evaluate job performance\n during hyperparameter tuning.
Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.
The Amazon Resource Name (ARN) of the IAM role that you specified for the\n model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
" } }, "VpcConfig": { @@ -47845,13 +47852,13 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.
" + "smithy.api#documentation": "Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } }, "DeploymentRecommendation": { @@ -47872,13 +47879,13 @@ "target": "com.amazonaws.sagemaker#AcceptEula", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The access configuration file to control access to the ML model. You can explicitly accept the model\n end-user license agreement (EULA) within the ModelAccessConfig.
If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
\nIf you are an AutoML user, see the Optional Parameters section of\n Create an AutoML job to fine-tune text generation models using the\n API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML\n API.
\nThe access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.
If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
If you are an AutoML user, see the Optional Parameters section of Create an AutoML job to fine-tune text generation models using the API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML API.
The path of the S3 object that contains the model artifacts. For example,\n s3://bucket-name/keynameprefix/model.tar.gz.
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default,\n these artifacts are uploaded to your Amazon S3 bucket as compressed files.
Provides information about the location that is configured for storing model artifacts.
Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.
JSON formatted S3 file that defines bias parameters. For more information on this JSON\n configuration file, see Configure\n bias parameters.
", + "smithy.api#documentation": "JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
", "smithy.api#required": {} } }, @@ -48049,7 +48056,7 @@ "ModelCardStatus": { "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.\n
" + "smithy.api#documentation": "The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
" } } }, @@ -48361,7 +48368,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "A Key Management Service\n key\n ID to use for encrypting a model card.
" + "smithy.api#documentation": "A Key Management Service key ID to use for encrypting a model card.
" } } }, @@ -48455,7 +48462,7 @@ "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The timeout value in seconds for an invocation request. The default value is\n 600.
" + "smithy.api#documentation": "The timeout value in seconds for an invocation request. The default value is 600.
" } }, "InvocationsMaxRetries": { "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", "traits": { - "smithy.api#documentation": "The maximum number of retries when invocation requests are failing. The default value\n is 3.
" + "smithy.api#documentation": "The maximum number of retries when invocation requests are failing. The default value is 3.
" } } }, "traits": { - "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" + "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job invocation.
" } }, "com.amazonaws.sagemaker#ModelCompilationConfig": { @@ -48703,7 +48710,7 @@ } }, "traits": { - "smithy.api#documentation": "An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into\n InAlert status.
An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.
For models created in SageMaker, this is the model ARN. For models created\n outside of SageMaker, this is a user-customized string.
" + "smithy.api#documentation": "For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.
" } }, "RiskRating": { @@ -48923,7 +48930,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.
" + "smithy.api#documentation": "Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.
" } }, "com.amazonaws.sagemaker#ModelDeployConfig": { @@ -48932,18 +48939,18 @@ "AutoGenerateEndpointName": { "target": "com.amazonaws.sagemaker#AutoGenerateEndpointName", "traits": { - "smithy.api#documentation": "Set to True to automatically generate an endpoint name for a one-click\n Autopilot model deployment; set to False otherwise. The default value is\n False.
If you set AutoGenerateEndpointName to True, do not specify\n the EndpointName; otherwise a 400 error is thrown.
Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.
If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.
Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.
\nSpecify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error is\n thrown.
Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.
Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.
Specifies how to generate the endpoint name for an automatic one-click Autopilot model\n deployment.
" + "smithy.api#documentation": "Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.
" } }, "com.amazonaws.sagemaker#ModelDeployResult": { @@ -48952,7 +48959,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "The name of the endpoint to which the model has been deployed.
\nIf model deployment fails, this field is omitted from the response.
\nThe name of the endpoint to which the model has been deployed.
If model deployment fails, this field is omitted from the response.
Provides a hash value that uniquely identifies the stored model\n artifacts.
" + "smithy.api#documentation": "Provides a hash value that uniquely identifies the stored model artifacts.
" } } }, @@ -48989,7 +48996,7 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "JSON formatted Amazon S3 file that defines explainability parameters. For more\n information on this JSON configuration file, see Configure model explainability parameters.
", + "smithy.api#documentation": "JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
", "smithy.api#required": {} } }, @@ -49045,7 +49052,7 @@ "target": "com.amazonaws.sagemaker#ModelInfrastructureType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The inference option to which to deploy your model. Possible values are the following:
\n\n RealTime: Deploy to real-time inference.
The inference option to which to deploy your model. Possible values are the following:
RealTime: Deploy to real-time inference.
The model latency percentile threshold. Acceptable values are P95 and P99.\n For custom load tests, specify the value as P95.
The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.
Part of the search expression. You can specify the name and value \n (domain, task, framework, framework version, task, and model).
" + "smithy.api#documentation": "Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).
" } }, "com.amazonaws.sagemaker#ModelMetadataFilterType": { @@ -49235,7 +49242,7 @@ } }, "traits": { - "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in \n a search. All resource objects that satisfy the expression's condition are \n included in the search results
" + "smithy.api#documentation": "One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results
" } }, "com.amazonaws.sagemaker#ModelMetadataSummaries": { @@ -49350,7 +49357,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "The name of the model package. The name can be as follows:
\nFor a versioned model, the name is automatically generated by SageMaker Model Registry and\n follows the format\n 'ModelPackageGroupName/ModelPackageVersion'.
For an unversioned model, you must provide the name.
\nThe name of the model package. The name can be as follows:
For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.
For an unversioned model, you must provide the name.
Specifies batch transform jobs that SageMaker runs to validate your model\n package.
" + "smithy.api#documentation": "Specifies batch transform jobs that SageMaker runs to validate your model package.
" } }, "ModelPackageStatus": { "target": "com.amazonaws.sagemaker#ModelPackageStatus", "traits": { - "smithy.api#documentation": "The status of the model package. This can be one of the following values.
\n\n PENDING - The model package is pending being created.
\n IN_PROGRESS - The model package is in the process of being\n created.
\n COMPLETED - The model package was successfully created.
\n FAILED - The model package failed.
\n DELETING - The model package is in the process of being\n deleted.
The status of the model package. This can be one of the following values.
PENDING - The model package is pending being created.
IN_PROGRESS - The model package is in the process of being created.
COMPLETED - The model package was successfully created.
FAILED - The model package failed.
DELETING - The model package is in the process of being deleted.
Whether the model package is to be certified to be listed on Amazon Web Services\n Marketplace. For information about listing model packages on Amazon Web Services\n Marketplace, see List Your Algorithm or Model\n Package on Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
" } }, "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
The approval status of the model. This can be one of the following values.
APPROVED - The model is approved
REJECTED - The model is rejected.
PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
Information about the user who created or modified an experiment, trial, trial\n component, lineage group, or project.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" } }, "MetadataProperties": { @@ -49452,7 +49459,7 @@ "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, or project.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" } }, "ApprovalDescription": { @@ -49464,19 +49471,19 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common machine\n learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning\n tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a\n single gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
" } }, "AdditionalInferenceSpecifications": { @@ -49506,7 +49513,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } }, "CustomerMetadataProperties": { @@ -49518,7 +49525,7 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" } }, "SkipModelValidation": { @@ -49529,7 +49536,7 @@ } }, "traits": { - "smithy.api#documentation": "A container for your trained model that can be deployed for SageMaker inference. This can\n include inference code, artifacts, and metadata. The model package type can be one of\n the following.
\nVersioned model: A part of a model package group in Model Registry.
\nUnversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.
\nFor more information, see \n CreateModelPackage\n .
A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.
Versioned model: A part of a model package group in Model Registry.
Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.
For more information, see CreateModelPackage .
The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" + "smithy.api#documentation": "An MD5 hash of the training algorithm that identifies the Docker image used for training.
" } }, "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nThe Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the model package.
The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling ListModelMetadata.
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.
The additional data source that is used during inference in the Docker container for\n your model package.
" + "smithy.api#documentation": "The additional data source that is used during inference in the Docker container for your model package.
" } }, "ModelDataETag": { @@ -49697,13 +49704,13 @@ "ModelPackageGroupStatus": { "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", "traits": { - "smithy.api#documentation": "The status of the model group. This can be one of the following values.
\n\n PENDING - The model group is pending being created.
\n IN_PROGRESS - The model group is in the process of being\n created.
\n COMPLETED - The model group was successfully created.
\n FAILED - The model group failed.
\n DELETING - The model group is in the process of being\n deleted.
\n DELETE_FAILED - SageMaker failed to delete the model group.
The status of the model group. This can be one of the following values.
PENDING - The model group is pending being created.
IN_PROGRESS - The model group is in the process of being created.
COMPLETED - The model group was successfully created.
FAILED - The model group failed.
DELETING - The model group is in the process of being deleted.
DELETE_FAILED - SageMaker failed to delete the model group.
A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } } }, @@ -49837,18 +49844,18 @@ "ModelCardContent": { "target": "com.amazonaws.sagemaker#ModelCardContent", "traits": { - "smithy.api#documentation": "The content of the model card. The content must follow the schema described in Model\n Package Model Card Schema.
" + "smithy.api#documentation": "The content of the model card. The content must follow the schema described in Model Package Model Card Schema.
" } }, "ModelCardStatus": { "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different\n organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates can be made\n to the model card content. If you try to update the model card content, you will\n receive the message Model Card is in Archived state.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
An optional Key Management Service key to encrypt, decrypt, and re-encrypt model\n package information for regulated workloads with highly sensitive data.
" + "smithy.api#documentation": "An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
" } }, "com.amazonaws.sagemaker#ModelPackageSortBy": { @@ -50008,7 +50015,7 @@ "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "If the model package is a versioned model, the model group that the versioned model\n belongs to.
" + "smithy.api#documentation": "If the model package is a versioned model, the model group that the versioned model belongs to.
" } }, "ModelPackageVersion": { @@ -50050,7 +50057,7 @@ "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "The approval status of the model. This can be one of the following values.
\n\n APPROVED - The model is approved
\n REJECTED - The model is rejected.
\n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.
The approval status of the model. This can be one of the following values.
APPROVED - The model is approved
REJECTED - The model is rejected.
PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
The TransformJobDefinition object that describes the transform job used\n for the validation of the model package.
The TransformJobDefinition object that describes the transform job used for the validation of the model package.
Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.
\nThe data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { @@ -50141,7 +50148,7 @@ "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that SageMaker runs to validate your model package.
An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" } }, "ProblemType": { @@ -50244,7 +50251,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" } }, "com.amazonaws.sagemaker#ModelQualityJobInput": { @@ -50269,7 +50276,7 @@ } }, "traits": { - "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.
" + "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.
" } }, "com.amazonaws.sagemaker#ModelQuantizationConfig": { @@ -50298,13 +50305,13 @@ "Status": { "target": "com.amazonaws.sagemaker#FeatureStatus", "traits": { - "smithy.api#documentation": "Describes whether the integration to the model registry is enabled or disabled in the\n Canvas application.
" + "smithy.api#documentation": "Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
" } }, "CrossAccountModelRegisterRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions\n created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services\n account in which SageMaker model registry is set up.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.
" } } }, @@ -50522,7 +50529,7 @@ "target": "com.amazonaws.sagemaker#ModelVariantStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of deployment for the model variant on the hosted inference endpoint.
\n\n Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.\n
\n InService - The model variant is running on the hosted inference endpoint.\n
\n Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.\n
\n Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.\n
\n Deleted - The model variant has been deleted on the hosted inference endpoint. This\n can only happen after stopping the experiment.\n
The status of deployment for the model variant on the hosted inference endpoint.
Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
InService - The model variant is running on the hosted inference endpoint.
Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into\n InAlert status.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.
A list of alert actions taken in response to an alert going into\n InAlert status.
A list of alert actions taken in response to an alert going into InAlert status.
A timestamp that indicates when the first alert transition occurred in an alert history.\n An alert transition can be from status InAlert to OK, \n or from OK to InAlert.
A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.
Within EvaluationPeriod, how many execution failures will raise an\n alert.
Within EvaluationPeriod, how many execution failures will raise an alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", + "smithy.api#documentation": "The number of most recent monitoring executions to consider when evaluating alert status.
", "smithy.api#required": {} } }, @@ -50741,7 +50748,7 @@ "target": "com.amazonaws.sagemaker#MonitoringAlertActions", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of alert actions taken in response to an alert going into\n InAlert status.
A list of alert actions taken in response to an alert going into InAlert status.
An Amazon S3 URI to a script that is called per row prior to running analysis. It can \n base64 decode the payload and convert it into a flattened JSON so that the built-in container can use \n the converted data. Applicable only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
" } }, "PostAnalyticsProcessorSourceUri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable \n only for the built-in (first party) containers.
" + "smithy.api#documentation": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" } } }, @@ -50814,18 +50821,18 @@ "ConstraintsResource": { "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource", "traits": { - "smithy.api#documentation": "The baseline constraint file in Amazon S3 that the current monitoring job should\n validated against.
" + "smithy.api#documentation": "The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
" } }, "StatisticsResource": { "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", "traits": { - "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should\n be validated against.
" + "smithy.api#documentation": "The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
" } } }, "traits": { - "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are \n compared against the results of the current job from the series of jobs scheduled to collect data \n periodically.
" + "smithy.api#documentation": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" } }, "com.amazonaws.sagemaker#MonitoringClusterConfig": { @@ -50835,7 +50842,7 @@ "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", + "smithy.api#documentation": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
", "smithy.api#required": {} } }, @@ -50851,14 +50858,14 @@ "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume, in gigabytes, that you want to provision. You must\n specify sufficient ML storage for your scenario.
", + "smithy.api#documentation": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt data on the storage volume attached to the ML compute instance(s) that run the\n model monitoring job.
" + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
" } } }, @@ -51124,7 +51131,7 @@ "BaselineConfig": { "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", "traits": { - "smithy.api#documentation": "Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics
" + "smithy.api#documentation": "Baseline configuration used to validate that the data conforms to the specified constraints and statistics
" } }, "MonitoringInputs": { @@ -51147,7 +51154,7 @@ "target": "com.amazonaws.sagemaker#MonitoringResources", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.
", + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
", "smithy.api#required": {} } }, @@ -51181,7 +51188,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can \n assume to perform tasks on your behalf.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
", "smithy.api#required": {} } } @@ -51302,13 +51309,13 @@ "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Whether to encrypt all communications between the instances used for the monitoring\n jobs. Choose True to encrypt communications. Encryption provides greater\n security for distributed jobs, but the processing might take longer.
Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the monitoring job.
" + "smithy.api#documentation": "Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
" } }, "VpcConfig": { @@ -51326,7 +51333,7 @@ "target": "com.amazonaws.sagemaker#MonitoringS3Output", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are\n saved.
", + "smithy.api#documentation": "The Amazon S3 storage location where the results of a monitoring job are saved.
", "smithy.api#required": {} } } @@ -51342,14 +51349,14 @@ "target": "com.amazonaws.sagemaker#MonitoringOutputs", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Monitoring outputs for monitoring jobs. This is where the output of the periodic\n monitoring jobs is uploaded.
", + "smithy.api#documentation": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to\n encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" + "smithy.api#documentation": "The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
" } } }, @@ -51422,7 +51429,7 @@ "target": "com.amazonaws.sagemaker#MonitoringS3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job.
", + "smithy.api#documentation": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job.
", "smithy.api#required": {} } }, @@ -51430,19 +51437,19 @@ "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker AI\n saves the results of a monitoring job. LocalPath is an absolute path for the output\n data.
", + "smithy.api#documentation": "The local path to the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job. LocalPath is an absolute path for the output data.
", "smithy.api#required": {} } }, "S3UploadMode": { "target": "com.amazonaws.sagemaker#ProcessingS3UploadMode", "traits": { - "smithy.api#documentation": "Whether to upload the results of the monitoring job continuously or after the job\n completes.
" + "smithy.api#documentation": "Whether to upload the results of the monitoring job continuously or after the job completes.
" } } }, "traits": { - "smithy.api#documentation": "Information about where and how you want to store the results of a monitoring\n job.
" + "smithy.api#documentation": "Information about where and how you want to store the results of a monitoring job.
" } }, "com.amazonaws.sagemaker#MonitoringS3Uri": { @@ -51473,7 +51480,7 @@ "MonitoringScheduleStatus": { "target": "com.amazonaws.sagemaker#ScheduleStatus", "traits": { - "smithy.api#documentation": "The status of the monitoring schedule. This can be one of the following values.
\n\n PENDING - The schedule is pending being created.
\n FAILED - The schedule failed.
\n SCHEDULED - The schedule was successfully created.
\n STOPPED - The schedule was stopped.
The status of the monitoring schedule. This can be one of the following values.
PENDING - The schedule is pending being created.
FAILED - The schedule failed.
SCHEDULED - The schedule was successfully created.
STOPPED - The schedule was stopped.
A list of the tags associated with the monitoring schedlue. For more information, see\n Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
" } } }, "traits": { - "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model\n Monitor.
" + "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.
" } }, "com.amazonaws.sagemaker#MonitoringScheduleArn": { @@ -51697,7 +51704,7 @@ "target": "com.amazonaws.sagemaker#MonitoringMaxRuntimeInSeconds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum runtime allowed in seconds.
\nThe MaxRuntimeInSeconds cannot exceed the frequency of the job. For data\n quality and model explainability, this can be up to 3600 seconds for an hourly schedule.\n For model bias and model quality hourly schedules, this can be up to 1800\n seconds.
The maximum runtime allowed in seconds.
The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
Whether to cache models for a multi-model endpoint. By default, multi-model endpoints\n cache models so that a model does not have to be loaded into memory each time it is\n invoked. Some use cases do not benefit from model caching. For example, if an endpoint\n hosts a large number of models that are each invoked infrequently, the endpoint might\n perform better if you disable model caching. To disable model caching, set the value of\n this parameter to Disabled.
Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.
The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the\n security groups for the VPC that is specified in the Subnets field.
The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC that you want to connect the compilation job to for\n accessing the model in Amazon S3.
", + "smithy.api#documentation": "The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The VpcConfig configuration object that specifies the VPC that you want the\n compilation jobs to connect to. For more information on controlling access to your Amazon S3\n buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to\n Resources in Your Amazon VPC.
" + "smithy.api#documentation": "The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to Resources in Your Amazon VPC.
" } }, "com.amazonaws.sagemaker#NeoVpcSecurityGroupId": { @@ -51854,7 +51861,7 @@ "target": "com.amazonaws.sagemaker#ResourcePropertyName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the property to use in the nested filters. The value must match a listed\n property name, such as InputDataConfig.
The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
A list of filters. Each filter acts on a property. Filters must contain at least one\n Filters value. For example, a NestedFilters call might include a\n filter on the PropertyName parameter of the InputDataConfig\n property: InputDataConfig.DataSource.S3DataSource.S3Uri.
A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.
A list of nested Filter objects. A resource must\n satisfy the conditions of all filters to be included in the results returned from the Search\n API.
\nFor example, to filter on a training job's InputDataConfig property with a\n specific channel name and S3Uri prefix, define the following filters:
\n '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',\n
\n '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\",\n \"Value\":\"mybucket/catdata\"}'\n
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\", \"Value\":\"mybucket/catdata\"}'
Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security\n for distributed processing jobs, but the processing might take longer.
Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for\n the processing job.
" + "smithy.api#documentation": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
" } }, "VpcConfig": { @@ -51903,7 +51910,7 @@ } }, "traits": { - "smithy.api#documentation": "Networking options for a job, such as network traffic encryption between containers,\n whether to allow inbound and outbound network calls to and from containers, and the VPC\n subnets and security groups to use for VPC-enabled jobs.
" + "smithy.api#documentation": "Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
" } }, "com.amazonaws.sagemaker#NetworkInterfaceId": { @@ -52159,12 +52166,12 @@ "Content": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigContent", "traits": { - "smithy.api#documentation": "A base64-encoded string that contains a shell script for a notebook instance lifecycle\n configuration.
" + "smithy.api#documentation": "A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
" } } }, "traits": { - "smithy.api#documentation": "Contains the notebook instance lifecycle configuration script.
\nEach lifecycle configuration script has a limit of 16384 characters.
\nThe value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log\n group /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + "smithy.api#documentation": "Contains the notebook instance lifecycle configuration script.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.
View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "com.amazonaws.sagemaker#NotebookInstanceName": { @@ -52302,7 +52309,7 @@ "Url": { "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", "traits": { - "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook running in your notebook\n instance.
" + "smithy.api#documentation": "The URL that you use to connect to the Jupyter notebook running in your notebook instance.
" } }, "InstanceType": { @@ -52326,19 +52333,19 @@ "NotebookInstanceLifecycleConfigName": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "The name of a notebook instance lifecycle configuration associated with this notebook\n instance.
\nFor information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.
" + "smithy.api#documentation": "The name of a notebook instance lifecycle configuration associated with this notebook instance.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } } }, @@ -52392,7 +52399,7 @@ } }, "traits": { - "smithy.api#documentation": "Configures Amazon SNS notifications of available or expiring work items for work\n teams.
" + "smithy.api#documentation": "Configures Amazon SNS notifications of available or expiring work items for work teams.
" } }, "com.amazonaws.sagemaker#NotificationTopicArn": { @@ -52471,24 +52478,24 @@ "Succeeded": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.
" + "smithy.api#documentation": "The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
" } }, "Pending": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs that are in progress and pending evaluation of their final\n objective metric.
" + "smithy.api#documentation": "The number of training jobs that are in progress and pending evaluation of their final objective metric.
" } }, "Failed": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs whose final objective metric was not evaluated and used in\n the hyperparameter tuning process. This typically occurs when the training job failed or\n did not emit an objective metric.
" + "smithy.api#documentation": "The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the number of training jobs that this hyperparameter tuning job launched,\n categorized by the status of their objective metric. The objective metric status shows\n whether the\n final\n objective metric for the training job has been evaluated by the\n tuning job and used in the hyperparameter tuning process.
" + "smithy.api#documentation": "Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
" } }, "com.amazonaws.sagemaker#OfflineStoreConfig": { @@ -52505,13 +52512,13 @@ "DisableGlueTableCreation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Set to True to disable the automatic creation of an Amazon Web Services Glue\n table when configuring an OfflineStore. If set to False, Feature\n Store will name the OfflineStore Glue table following Athena's\n naming recommendations.
The default value is False.
Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.
The default value is False.
The meta data of the Glue table that is autogenerated when an OfflineStore\n is created.
The meta data of the Glue table that is autogenerated when an OfflineStore is created.
The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.
The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.
A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.
" + "smithy.api#documentation": "A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
" } } }, "traits": { - "smithy.api#documentation": "A list of user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.
A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your\n OnlineStore.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
Turn OnlineStore off by specifying False for the\n EnableOnlineStore flag. Turn OnlineStore on by specifying\n True for the EnableOnlineStore flag.
The default value is False.
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Option for different tiers of low latency storage for real-time data retrieval.
\n\n Standard: A managed low latency data store for feature groups.
\n InMemory: A managed data store for feature groups that supports very\n low latency retrieval.
Option for different tiers of low latency storage for real-time data retrieval.
Standard: A managed low latency data store for feature groups.
InMemory: A managed data store for feature groups that supports very low latency retrieval.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly.
The default value is False.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.
The default value is False.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store\n uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side\n encryption.
\nThe caller (either user or IAM role) of CreateFeatureGroup must have below\n permissions to the OnlineStore\n KmsKeyId:
\n \"kms:Encrypt\"\n
\n \"kms:Decrypt\"\n
\n \"kms:DescribeKey\"\n
\n \"kms:CreateGrant\"\n
\n \"kms:RetireGrant\"\n
\n \"kms:ReEncryptFrom\"\n
\n \"kms:ReEncryptTo\"\n
\n \"kms:GenerateDataKey\"\n
\n \"kms:ListAliases\"\n
\n \"kms:ListGrants\"\n
\n \"kms:RevokeGrant\"\n
The caller (either user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have the\n following permissions to the KmsKeyId:
\n \"kms:Decrypt\"\n
The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:
\"kms:Encrypt\"
\"kms:Decrypt\"
\"kms:DescribeKey\"
\"kms:CreateGrant\"
\"kms:RetireGrant\"
\"kms:ReEncryptFrom\"
\"kms:ReEncryptTo\"
\"kms:GenerateDataKey\"
\"kms:ListAliases\"
\"kms:ListGrants\"
\"kms:RevokeGrant\"
The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:
\"kms:Decrypt\"
Settings for an optimization technique that you apply with a model optimization\n job.
" + "smithy.api#documentation": "Settings for an optimization technique that you apply with a model optimization job.
" } }, "com.amazonaws.sagemaker#OptimizationConfigs": { @@ -53202,14 +53209,14 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the\n optimized model when SageMaker uploads the model to Amazon S3.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.
" } }, "S3OutputLocation": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon S3 URI for where to store the optimized model that you create with an optimization\n job.
", + "smithy.api#documentation": "The Amazon S3 URI for where to store the optimized model that you create with an optimization job.
", "smithy.api#required": {} } } @@ -53349,7 +53356,7 @@ "target": "com.amazonaws.sagemaker#OptimizationModelAcceptEula", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The image that SageMaker recommends that you use to host the optimized model that you created\n with an optimization job.
" + "smithy.api#documentation": "The image that SageMaker recommends that you use to host the optimized model that you created with an optimization job.
" } } }, @@ -53388,7 +53395,7 @@ "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized\n model.
", + "smithy.api#documentation": "The ID of the subnets in the VPC to which you want to connect your optimized model.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization\n job. You can control access to and from your resources by configuring a VPC. For more\n information, see Give SageMaker Access to Resources in your Amazon VPC.
" + "smithy.api#documentation": "A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
" } }, "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId": { @@ -53504,37 +53511,37 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform\n fields. It can be used instead of TargetPlatform.
Currently ml_trn1 is available only in US East (N. Virginia) Region,\n and ml_inf2 is available only in US East (Ohio) Region.
Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.
Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n
\n \"CompilerOptions\": {'mattr': ['+neon']}\n
Jetson TX2
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n
EC2 m5.2xlarge instance OS
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n
\n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n
RK3399
\n\n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n
ARMv7 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n
ARMv8 phone (CPU)
\n\n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n
\n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.
The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},
\"CompilerOptions\": {'mattr': ['+neon']}
Jetson TX2
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"NVIDIA\"},
\"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}
EC2 m5.2xlarge instance OS
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\": \"NVIDIA\"},
\"CompilerOptions\": {'mcpu': 'skylake-avx512'}
RK3399
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"MALI\"}
ARMv7 phone (CPU)
\"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},
\"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}
ARMv8 phone (CPU)
\"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},
\"CompilerOptions\": {'ANDROID_PLATFORM': 29}
Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n
\n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:
float32: Use either \"float\" or\n \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
\n CPU: Compilation for CPU supports the following compiler\n options.
\n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n
\n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n
\n ARM: Details of ARM CPU compilations.
\n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.
\n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.
\n gpu_code: Specifies the targeted architecture.
\n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.
\n cuda-ver: Specifies the CUDA version in x.y\n format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n
\n ANDROID: Compilation for the Android OS supports the following\n compiler options:
\n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.
\n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.
\n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1\n --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI Reference Guide.
\n\n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:
\n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example, {\"class_labels\":\n \"imagenet_labels_1000.txt\"}. Labels inside the txt file\n should be separated by newlines.
Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model's input. \"float32\" is used if \"DTYPE\" is not specified. Options for data type are:
float32: Use either \"float\" or \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
CPU: Compilation for CPU supports the following compiler options.
mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM: Details of ARM CPU compilations.
NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.
gpu_code: Specifies the targeted architecture.
trt-ver: Specifies the TensorRT versions in x.y.z. format.
cuda-ver: Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID: Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.
mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI Reference Guide.
CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:
class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI\n uses to encrypt your output models with Amazon S3 server-side encryption after compilation\n job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer\n Guide.\n
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
Contains information about the output location for the compiled model and the target\n device that the model runs on. TargetDevice and TargetPlatform\n are mutually exclusive, so you need to choose one between the two to specify your target\n device or platform. If you cannot find your device you want to use from the\n TargetDevice list, use TargetPlatform to describe the\n platform of your edge device and CompilerOptions if there are specific\n settings that are required or recommended to use for particular TargetPlatform.
Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3\n managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
Identifies the S3 path where you want SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.
Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
The model output compression type. Select None to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.
The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
Provides information about how to store model training results (model\n artifacts).
" + "smithy.api#documentation": "Provides information about how to store model training results (model artifacts).
" } }, "com.amazonaws.sagemaker#OutputParameter": { @@ -53654,7 +53661,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.
" + "smithy.api#documentation": "Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
" } }, "com.amazonaws.sagemaker#Parameter": { @@ -53664,7 +53671,7 @@ "target": "com.amazonaws.sagemaker#PipelineParameterName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.
", + "smithy.api#documentation": "The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
", "smithy.api#required": {} } }, @@ -53719,24 +53726,24 @@ "IntegerParameterRangeSpecification": { "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", "traits": { - "smithy.api#documentation": "A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.
A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible\n values for a categorical hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
Defines the possible values for categorical, continuous, and integer hyperparameters\n to be used by an algorithm.
" + "smithy.api#documentation": "Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.
" } }, "com.amazonaws.sagemaker#ParameterRanges": { @@ -53745,30 +53752,30 @@ "IntegerParameterRanges": { "target": "com.amazonaws.sagemaker#IntegerParameterRanges", "traits": { - "smithy.api#documentation": "The array of IntegerParameterRange objects that specify ranges of integer\n hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
" } }, "ContinuousParameterRanges": { "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", "traits": { - "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of continuous\n hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
" } }, "CategoricalParameterRanges": { "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", "traits": { - "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges of categorical\n hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
" } }, "AutoParameters": { "target": "com.amazonaws.sagemaker#AutoParameters", "traits": { - "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to\n determine optimal ranges for your tuning job.
" + "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
" } } }, "traits": { - "smithy.api#documentation": "Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.
\nThe maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.
Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.
The trial that a trial component is associated with and the experiment the trial is part\n of. A component might not be associated with a trial. A component can be associated with\n multiple trials.
" + "smithy.api#documentation": "The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.
" } }, "com.amazonaws.sagemaker#ParentHyperParameterTuningJob": { @@ -53848,12 +53855,12 @@ "HyperParameterTuningJobName": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "The name of the hyperparameter tuning job to be used as a starting point for a new\n hyperparameter tuning job.
" + "smithy.api#documentation": "The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
" } } }, "traits": { - "smithy.api#documentation": "A previously completed or stopped hyperparameter tuning job to be used as a starting\n point for a new hyperparameter tuning job.
" + "smithy.api#documentation": "A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
" } }, "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs": { @@ -54100,7 +54107,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint for the in-progress deployment.
" + "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.
" } }, "StartTime": { @@ -54112,12 +54119,12 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint in shadow mode with production traffic replicated from the model specified\n on ProductionVariants for the in-progress deployment.
An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.
The summary of an in-progress deployment when an endpoint is creating or updating with\n a new endpoint configuration.
" + "smithy.api#documentation": "The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.
" } }, "com.amazonaws.sagemaker#PendingProductionVariantSummary": { @@ -54134,7 +54141,7 @@ "DeployedImages": { "target": "com.amazonaws.sagemaker#DeployedImages", "traits": { - "smithy.api#documentation": "An array of DeployedImage objects that specify the Amazon EC2 Container\n Registry paths of the inference images deployed on instances of this\n ProductionVariant.
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
The requested weight for the variant in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" + "smithy.api#documentation": "The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" } }, "CurrentInstanceCount": { @@ -54158,7 +54165,7 @@ "DesiredInstanceCount": { "target": "com.amazonaws.sagemaker#TaskCount", "traits": { - "smithy.api#documentation": "The number of instances requested in this deployment, as specified in the endpoint\n configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" + "smithy.api#documentation": "The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
" } }, "InstanceType": { @@ -54170,13 +54177,13 @@ "AcceleratorType": { "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify the size of the EI instance to use for the production variant.
" } }, "VariantStatus": { "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", "traits": { - "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or\n operational status.
" + "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or operational status.
" } }, "CurrentServerlessConfig": { @@ -54194,18 +54201,18 @@ "ManagedInstanceScaling": { "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
" } }, "RoutingConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
" } } }, "traits": { - "smithy.api#documentation": "The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint\n or UpdateEndpoint\n operations. Describes the VariantStatus , weight and capacity for a\n production variant associated with an endpoint.
The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.
Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.
Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.
The object key (or key name) uniquely identifies the \n object in an S3 bucket.
", + "smithy.api#documentation": "The object key (or key name) uniquely identifies the object in an S3 bucket.
", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.sagemaker#VersionId", "traits": { - "smithy.api#documentation": "Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.
" + "smithy.api#documentation": "Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
" } } }, @@ -54628,7 +54635,7 @@ "SelectiveExecutionResult": { "target": "com.amazonaws.sagemaker#SelectiveExecutionResult", "traits": { - "smithy.api#documentation": "The ARN from an execution of the current pipeline from which\n results are reused for this step.
" + "smithy.api#documentation": "The ARN from an execution of the current pipeline from which results are reused for this step.
" } } }, @@ -54696,13 +54703,13 @@ "Callback": { "target": "com.amazonaws.sagemaker#CallbackStepMetadata", "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue used by this step execution, the pipeline generated token,\n and a list of output parameters.
" + "smithy.api#documentation": "The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
" } }, "Lambda": { "target": "com.amazonaws.sagemaker#LambdaStepMetadata", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of\n output parameters.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
" } }, "EMR": { @@ -54714,13 +54721,13 @@ "QualityCheck": { "target": "com.amazonaws.sagemaker#QualityCheckStepMetadata", "traits": { - "smithy.api#documentation": "The configurations and outcomes of the check step execution. This includes:
\nThe type of the check conducted.
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe Boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
The configurations and outcomes of the check step execution. This includes:
The type of the check conducted.
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The Boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:
The type of the check conducted,
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
Weight of the priority class. The value is within a range from 0 to 100, where 0 is the\n default.
\nA weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the\n default.
", + "smithy.api#documentation": "Weight of the priority class. The value is within a range from 0 to 100, where 0 is the default.
A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Priority class configuration. When included in PriorityClasses, these class\n configurations define how tasks are queued.
Priority class configuration. When included in PriorityClasses, these class configurations define how tasks are queued.
The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.
", + "smithy.api#documentation": "The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
", "smithy.api#required": {} } }, @@ -55091,14 +55098,14 @@ "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.
\nCertain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker\n mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.
For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.
\nThe size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.
For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker\n uses to encrypt data on the storage volume attached to the ML compute instance(s) that\n run the processing job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output.\n Note that your processing script is responsible for putting records into your Feature\n Store.
", + "smithy.api#documentation": "The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.
", "smithy.api#required": {} } } @@ -55171,13 +55178,13 @@ "AppManaged": { "target": "com.amazonaws.sagemaker#AppManaged", "traits": { - "smithy.api#documentation": "When True, input operations such as data download are managed natively by\n the processing job application. When False (default), input operations are\n managed by Amazon SageMaker.
When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
Configuration for downloading input data from Amazon S3 into the processing\n container.
" + "smithy.api#documentation": "Configuration for downloading input data from Amazon S3 into the processing container.
" } }, "DatasetDefinition": { @@ -55188,7 +55195,7 @@ } }, "traits": { - "smithy.api#documentation": "The inputs for a processing job. The processing input must specify exactly one of\n either S3Input or DatasetDefinition types.
The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
A string, up to one KB in size, that contains metadata from the processing container\n when the processing job exits.
" + "smithy.api#documentation": "A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" } }, "ProcessingEndTime": { @@ -55871,13 +55878,13 @@ "MonitoringScheduleArn": { "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", "traits": { - "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing\n job.
" + "smithy.api#documentation": "The ARN of a monitoring schedule for an endpoint associated with this processing job.
" } }, "AutoMLJobArn": { "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job associated with this processing\n job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
" } }, "TrainingJobArn": { @@ -55889,12 +55896,12 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and\n Cost Management User Guide.
" + "smithy.api#documentation": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" } } }, "traits": { - "smithy.api#documentation": "An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more\n information, see Process Data and Evaluate\n Models.
" + "smithy.api#documentation": "An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
" } }, "com.amazonaws.sagemaker#ProcessingJobArn": { @@ -56022,13 +56029,13 @@ "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.
" + "smithy.api#documentation": "A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" } }, "ExitMessage": { "target": "com.amazonaws.sagemaker#ExitMessage", "traits": { - "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.
" + "smithy.api#documentation": "An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" } } }, @@ -56075,18 +56082,18 @@ "FeatureStoreOutput": { "target": "com.amazonaws.sagemaker#ProcessingFeatureStoreOutput", "traits": { - "smithy.api#documentation": "Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output\n type is only supported when AppManaged is specified.
Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.
When True, output operations such as data upload are managed natively by\n the processing job application. When False (default), output operations are\n managed by Amazon SageMaker.
When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
Describes the results of a processing job. The processing output must specify exactly\n one of either S3Output or FeatureStoreOutput types.
Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
An array of outputs configuring the data to upload from the processing\n container.
", + "smithy.api#documentation": "An array of outputs configuring the data to upload from the processing container.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker\n uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS\n key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to\n all outputs.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
The configuration for the resources in a cluster used to run the processing\n job.
", + "smithy.api#documentation": "The configuration for the resources in a cluster used to run the processing job.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.
" + "smithy.api#documentation": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
" } }, "com.amazonaws.sagemaker#ProcessingS3CompressionType": { @@ -56197,45 +56204,45 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing\n job.
", + "smithy.api#documentation": "The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
", "smithy.api#required": {} } }, "LocalPath": { "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "The local path in your container where you want Amazon SageMaker to write input data to.\n LocalPath is an absolute path to the input data and must begin with\n /opt/ml/processing/. LocalPath is a required parameter\n when AppManaged is False (default).
The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
Whether you use an S3Prefix or a ManifestFile for the data\n type. If you choose S3Prefix, S3Uri identifies a key name\n prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job.\n If you choose ManifestFile, S3Uri identifies an object that is\n a manifest file containing a list of object keys that you want Amazon SageMaker to use for the\n processing job.
Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker\n copies the data from the input source onto the local ML storage volume before starting\n your processing container. This is the most commonly used input mode. In\n Pipe mode, Amazon SageMaker streams input data from the source directly to your\n processing container into named pipes without using the ML storage volume.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
Whether to distribute the data from Amazon S3 to all processing instances with\n FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key,\n downloading one shard of data to each processing instance.
Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing\n container. Gzip can only be used when Pipe mode is specified\n as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from\n the source directly to your container without using the EBS volume.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
Configuration for downloading input data from Amazon S3 into the processing\n container.
" + "smithy.api#documentation": "Configuration for downloading input data from Amazon S3 into the processing container.
" } }, "com.amazonaws.sagemaker#ProcessingS3InputMode": { @@ -56262,21 +56269,21 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.
", + "smithy.api#documentation": "A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
", "smithy.api#required": {} } }, "LocalPath": { "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.\n LocalPath is an absolute path to a directory containing output files.\n This directory will be created by the platform and exist when your container's\n entrypoint is invoked.
The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job\n completes.
", + "smithy.api#documentation": "Whether to upload the results of the processing job continuously or after the job completes.
", "smithy.api#required": {} } } @@ -56315,7 +56322,7 @@ } }, "traits": { - "smithy.api#documentation": "Configures conditions under which the processing job should be stopped, such as how\n long the processing job has been running. After the condition is met, the processing job\n is stopped.
" + "smithy.api#documentation": "Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
" } }, "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB": { @@ -56374,7 +56381,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "The name of the model that you want to host. This is the name that you specified\n when creating the model.
" + "smithy.api#documentation": "The name of the model that you want to host. This is the name that you specified when creating the model.
" } }, "InitialInstanceCount": { @@ -56392,19 +56399,19 @@ "InitialVariantWeight": { "target": "com.amazonaws.sagemaker#VariantWeight", "traits": { - "smithy.api#documentation": "Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n
Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.
This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify the size of the EI instance to use for the\n production variant.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify the size of the EI instance to use for the production variant.
" } }, "CoreDumpConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantCoreDumpConfig", "traits": { - "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process\n crashes.
" + "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process crashes.
" } }, "ServerlessConfig": { @@ -56416,48 +56423,48 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#ProductionVariantVolumeSizeInGB", "traits": { - "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual inference instance\n associated with the production variant. Currently only Amazon EBS gp2 storage volumes are\n supported.
" + "smithy.api#documentation": "The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.
" } }, "ModelDataDownloadTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host\n from Amazon S3 to the individual inference instance associated with this production\n variant.
" + "smithy.api#documentation": "The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.
" } }, "ContainerStartupHealthCheckTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", "traits": { - "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by\n SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" + "smithy.api#documentation": "The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.
" } }, "EnableSSMAccess": { "target": "com.amazonaws.sagemaker#ProductionVariantSSMAccess", "traits": { - "smithy.api#documentation": " You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.
You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.
Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
" } }, "RoutingConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
" } }, "InferenceAmiVersion": { "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", "traits": { - "smithy.api#documentation": "Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.
\nBy selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.
\nThe AMI version names, and their configurations, are the following:
\nAccelerator: GPU
\nNVIDIA driver version: 535
\nCUDA version: 12.2
\nAccelerator: GPU
\nNVIDIA driver version: 535
\nCUDA version: 12.2
\nNVIDIA Container Toolkit with disabled CUDA-compat mounting
\nAccelerator: GPU
\nNVIDIA driver version: 550
\nCUDA version: 12.4
\nNVIDIA Container Toolkit with disabled CUDA-compat mounting
\nAccelerator: Inferentia2 and Trainium
\nNeuron driver version: 2.19
\nSpecifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.
By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.
The AMI version names, and their configurations, are the following:
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Accelerator: GPU
NVIDIA driver version: 550
CUDA version: 12.4
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Accelerator: Inferentia2 and Trainium
Neuron driver version: 2.19
Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check Production variants.\n
" + "smithy.api#documentation": "Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.
" } }, "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { @@ -56524,12 +56531,12 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
Specifies configuration for a core dump from the model container when the process\n crashes.
" + "smithy.api#documentation": "Specifies configuration for a core dump from the model container when the process crashes.
" } }, "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion": { @@ -57934,18 +57941,18 @@ "MinInstanceCount": { "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMinInstanceCount", "traits": { - "smithy.api#documentation": "The minimum number of instances that the endpoint must retain when it scales down to\n accommodate a decrease in traffic.
" + "smithy.api#documentation": "The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.
" } }, "MaxInstanceCount": { "target": "com.amazonaws.sagemaker#ManagedInstanceScalingMaxInstanceCount", "traits": { - "smithy.api#documentation": "The maximum number of instances that the endpoint can provision when it scales up to\n accommodate an increase in traffic.
" + "smithy.api#documentation": "The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.
" } } }, "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
" } }, "com.amazonaws.sagemaker#ProductionVariantModelDataDownloadTimeoutInSeconds": { @@ -57964,13 +57971,13 @@ "target": "com.amazonaws.sagemaker#RoutingStrategy", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Sets how the endpoint routes incoming traffic:
\n\n LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the\n specific instances that have more capacity to process them.
\n RANDOM: The endpoint routes each request to a randomly chosen\n instance.
Sets how the endpoint routes incoming traffic:
LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.
RANDOM: The endpoint routes each request to a randomly chosen instance.
Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
" } }, "com.amazonaws.sagemaker#ProductionVariantSSMAccess": { @@ -57998,7 +58005,7 @@ "ProvisionedConcurrency": { "target": "com.amazonaws.sagemaker#ServerlessProvisionedConcurrency", "traits": { - "smithy.api#documentation": "The amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
This field is not supported for serverless endpoint recommendations for Inference Recommender jobs.\n For more information about creating an Inference Recommender job, see\n CreateInferenceRecommendationsJobs.
\nThe amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.
This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.
The updated amount of provisioned concurrency to allocate for the serverless endpoint.\n Should be less than or equal to MaxConcurrency.
The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.
The endpoint variant status which describes the current deployment stage status or\n operational status.
\n\n Creating: Creating inference resources for the production\n variant.
\n Deleting: Terminating inference resources for the production\n variant.
\n Updating: Updating capacity for the production variant.
\n ActivatingTraffic: Turning on traffic for the production\n variant.
\n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.
The endpoint variant status which describes the current deployment stage status or operational status.
Creating: Creating inference resources for the production variant.
Deleting: Terminating inference resources for the production variant.
Updating: Updating capacity for the production variant.
ActivatingTraffic: Turning on traffic for the production variant.
Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.
An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.
The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.
The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
The endpoint variant status which describes the current deployment stage status or\n operational status.
" + "smithy.api#documentation": "The endpoint variant status which describes the current deployment stage status or operational status.
" } }, "CurrentServerlessConfig": { @@ -58128,18 +58135,18 @@ "ManagedInstanceScaling": { "target": "com.amazonaws.sagemaker#ProductionVariantManagedInstanceScaling", "traits": { - "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions\n as it scales up or down to accommodate traffic.
" + "smithy.api#documentation": "Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
" } }, "RoutingConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantRoutingConfig", "traits": { - "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.
" + "smithy.api#documentation": "Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
" } } }, "traits": { - "smithy.api#documentation": "Describes weight and capacities for a production variant associated with an\n endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\n API and the endpoint status is Updating, you get different desired and\n current values.
Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.
A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" + "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" } }, "ProfilingParameters": { "target": "com.amazonaws.sagemaker#ProfilingParameters", "traits": { - "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
" } }, "com.amazonaws.sagemaker#ProfilerConfigForUpdate": { @@ -58206,13 +58213,13 @@ "ProfilingIntervalInMilliseconds": { "target": "com.amazonaws.sagemaker#ProfilingIntervalInMilliseconds", "traits": { - "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are\n 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" + "smithy.api#documentation": "A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" } }, "ProfilingParameters": { "target": "com.amazonaws.sagemaker#ProfilingParameters", "traits": { - "smithy.api#documentation": "Configuration information for capturing framework metrics. Available key strings for different profiling options are\n DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig.\n The following codes are configuration structures for the ProfilingParameters parameter. To learn more about\n how to configure the ProfilingParameters parameter, \n see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.\n
Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and\n storage paths.
" + "smithy.api#documentation": "Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.
" } }, "com.amazonaws.sagemaker#ProfilerRuleConfiguration": { @@ -58441,7 +58448,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } }, "LastModifiedTime": { @@ -58670,7 +58677,7 @@ } }, "traits": { - "smithy.api#documentation": "Part of the SuggestionQuery type. Specifies a hint for retrieving property\n names that begin with the specified text.
Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.
A suggested property name based on what you entered in the search textbox in the SageMaker\n console.
" + "smithy.api#documentation": "A suggested property name based on what you entered in the search textbox in the SageMaker console.
" } } }, "traits": { - "smithy.api#documentation": "A property name returned from a GetSearchSuggestions call that specifies a\n value in the PropertyNameQuery field.
A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.
A key value pair used when you provision a project as a service catalog product. For\n information, see What is Amazon Web Services Service\n Catalog.
" + "smithy.api#documentation": "A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.
" } }, "com.amazonaws.sagemaker#ProvisioningParameterKey": { @@ -58756,7 +58763,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
\nUse one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.
\n0.012
\n0.024
\n0.036
\n0.048
\n0.060
\n0.072
\n0.120
\n0.240
\n0.360
\n0.480
\n0.600
\n0.720
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.
\n0.840
\n0.960
\n1.080
\n1.200
\nUse one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n2.400
\n2.280
\n2.160
\n2.040
\n1.920
\n1.800
\n1.680
\n1.560
\n1.440
\n1.320
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nUse one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.
\n1.200
\n1.080
\n0.960
\n0.840
\n0.720
\n0.600
\n0.480
\n0.360
\n0.240
\n0.120
\n0.072
\n0.060
\n0.048
\n0.036
\n0.024
\n0.012
\nDefines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
0.012
0.024
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
0.840
0.960
1.080
1.200
Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.
2.400
2.280
2.160
2.040
1.920
1.800
1.680
1.560
1.440
1.320
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services\n Identity and Access Management User Guide..
" + "smithy.api#documentation": "Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
" } }, "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { @@ -58876,18 +58883,18 @@ "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints and \n BaselineUsedForDriftCheckStatistics properties.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.
Container for the metadata for a Quality check step. For more information, see \n the topic on QualityCheck step in the Amazon SageMaker Developer Guide.\n
" + "smithy.api#documentation": "Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
" } }, "com.amazonaws.sagemaker#QueryFilters": { @@ -58896,7 +58903,7 @@ "Types": { "target": "com.amazonaws.sagemaker#QueryTypes", "traits": { - "smithy.api#documentation": "Filter the lineage entities connected to the StartArn by type. For example: DataSet, \n Model, Endpoint, or ModelDeployment.
Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.
Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.
A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.
Use this action to inspect your lineage and discover relationships between entities. \n For more information, see \n Querying Lineage Entities in the Amazon SageMaker Developer Guide.
", + "smithy.api#documentation": "Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -58990,25 +58997,25 @@ "Direction": { "target": "com.amazonaws.sagemaker#Direction", "traits": { - "smithy.api#documentation": "Associations between lineage entities have a direction. This parameter determines the direction from the \n StartArn(s) that the query traverses.
" + "smithy.api#documentation": "Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
" } }, "IncludeEdges": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": " Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.
Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.
A set of filtering parameters that allow you to specify which entities should be returned.
\nProperties - Key-value pairs to match on the lineage entities' properties.
\nLineageTypes - A set of lineage entity types to match on. For example: TrialComponent, \n Artifact, or Context.
CreatedBefore - Filter entities created before this date.
\nModifiedBefore - Filter entities modified before this date.
\nModifiedAfter - Filter entities modified after this date.
\nA set of filtering parameters that allow you to specify which entities should be returned.
Properties - Key-value pairs to match on the lineage entities' properties.
LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.
CreatedBefore - Filter entities created before this date.
ModifiedBefore - Filter entities modified before this date.
ModifiedAfter - Filter entities modified after this date.
The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.
The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.
A list of custom SageMaker AI images that are configured to run as a RSession\n app.
" + "smithy.api#documentation": "A list of custom SageMaker AI images that are configured to run as a RSession app.
" } } }, @@ -59145,18 +59152,18 @@ "AccessStatus": { "target": "com.amazonaws.sagemaker#RStudioServerProAccessStatus", "traits": { - "smithy.api#documentation": "Indicates whether the current user has access to the RStudioServerPro\n app.
Indicates whether the current user has access to the RStudioServerPro app.
The level of permissions that the user has within the RStudioServerPro app.\n This value defaults to `User`. The `Admin` value allows the user access to the RStudio\n Administrative Dashboard.
The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
The ARN of the execution role for the RStudioServerPro Domain-level\n app.
The ARN of the execution role for the RStudioServerPro Domain-level app.
A collection of settings that configure the RStudioServerPro Domain-level\n app.
A collection of settings that configure the RStudioServerPro Domain-level app.
A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.
A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.
Identifies the Amazon S3 bucket where you want SageMaker to store the \n compiled model artifacts.
" + "smithy.api#documentation": "Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" + "smithy.api#documentation": "Provides information about the output configuration for the compiled model.
" } }, "com.amazonaws.sagemaker#RecommendationJobContainerConfig": { @@ -59361,19 +59368,19 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of the model and its components.
\nValid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING |\n MACHINE_LEARNING\n
The machine learning domain of the model and its components.
Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING
The machine learning task that the model accomplishes.
\nValid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION\n | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION |\n REGRESSION | OTHER\n
The machine learning task that the model accomplishes.
Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
The machine learning framework of the container image.
\nValid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN\n
The machine learning framework of the container image.
Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
\nValid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn |\n densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet\n
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.
Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet
The endpoint type to receive recommendations for. By default this is null, and the results of \n the inference recommendation job return a combined list of both real-time and serverless benchmarks.\n By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
" + "smithy.api#documentation": "The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
" } }, "DataInputConfig": { "target": "com.amazonaws.sagemaker#RecommendationJobDataInputConfig", "traits": { - "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form.\n This field is used for optimizing your model using SageMaker Neo. For more information, see\n DataInputConfig.
" + "smithy.api#documentation": "Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.
" } }, "SupportedResponseMIMETypes": { @@ -59420,7 +59427,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job directly in the\n CreateInferenceRecommendationsJob\n API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use\n ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.
Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.
\nThe SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" } }, "ContainerConfig": { "target": "com.amazonaws.sagemaker#RecommendationJobContainerConfig", "traits": { - "smithy.api#documentation": "Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig\n override the corresponding fields in the model package.
Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:\n
For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
" } }, "CompiledOutputConfig": { "target": "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig", "traits": { - "smithy.api#documentation": "Provides information about the output configuration for the compiled \n model.
" + "smithy.api#documentation": "Provides information about the output configuration for the compiled model.
" } } }, @@ -59629,7 +59636,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the maximum number of jobs that can run in parallel \n and the maximum number of jobs that can run.
" + "smithy.api#documentation": "Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.
" } }, "com.amazonaws.sagemaker#RecommendationJobStatus": { @@ -59697,18 +59704,18 @@ "ModelLatencyThresholds": { "target": "com.amazonaws.sagemaker#ModelLatencyThresholds", "traits": { - "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.
" + "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
" } }, "FlatInvocations": { "target": "com.amazonaws.sagemaker#FlatInvocations", "traits": { - "smithy.api#documentation": "Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.
Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.
Specifies conditions for stopping a job. When a job reaches a \n stopping condition limit, SageMaker ends the job.
" + "smithy.api#documentation": "Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.
" } }, "com.amazonaws.sagemaker#RecommendationJobSupportedContentType": { @@ -59790,7 +59797,7 @@ "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs. IDs have the form of sg-xxxxxxxx.\n Specify the security groups for the VPC that is specified in the Subnets field.
The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The expected CPU utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The expected CPU utilization at maximum invocations per minute for the instance.
NaN indicates that the value is not available.
The expected memory utilization at maximum invocations per minute for the instance.
\n\n NaN indicates that the value is not available.
The expected memory utilization at maximum invocations per minute for the instance.
NaN indicates that the value is not available.
The time it takes to launch new compute resources for a serverless endpoint.\n The time can vary depending on the model size, how long it takes to download the\n model, and the start-up time of the container.
\n\n NaN indicates that the value is not available.
The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.
NaN indicates that the value is not available.
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate\n datasets.
", + "smithy.api#documentation": "The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
", "smithy.api#required": {} } }, @@ -60030,7 +60037,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker\n uses to encrypt data from a Redshift execution.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
" } }, "OutputFormat": { @@ -60138,6 +60145,15 @@ "smithy.api#pattern": "^\\d{1,4}.\\d{1,4}.\\d{1,4}$" } }, + "com.amazonaws.sagemaker#RegionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 24 + } + } + }, "com.amazonaws.sagemaker#RegisterDevices": { "type": "operation", "input": { @@ -60237,7 +60253,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + "smithy.api#documentation": "Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
" } }, "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate": { @@ -60251,7 +60267,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" + "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
" } }, "com.amazonaws.sagemaker#RenderUiTemplate": { @@ -60284,7 +60300,7 @@ "target": "com.amazonaws.sagemaker#RenderableTask", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A RenderableTask object containing a representative task to\n render.
A RenderableTask object containing a representative task to render.
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
", "smithy.api#required": {} } }, "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
" + "smithy.api#documentation": "The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
" } } }, @@ -60322,7 +60338,7 @@ "target": "com.amazonaws.sagemaker#RenderingErrorList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.
A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.
A JSON object that contains values for the variables defined in the template. It is\n made available to the template under the substitution variable task.input.\n For example, if you define a variable task.input.text in your template, you\n can supply the variable in the JSON object as \"text\": \"sample text\".
A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as \"text\": \"sample text\".
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides\n credentials to authenticate to the private Docker registry where your model image is\n hosted. For information about how to create an Amazon Web Services Lambda function, see\n Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies an authentication configuration for the private docker registry where your\n model image is hosted. Specify a value for this property only if you specified\n Vpc as the value for the RepositoryAccessMode field of the\n ImageConfig object that you passed to a call to\n CreateModel and the private Docker registry where the model image is\n hosted requires authentication.
Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.
The number of whole hours in the total duration for this reserved capacity\n offering.
" + "smithy.api#documentation": "The number of whole hours in the total duration for this reserved capacity offering.
" } }, "DurationMinutes": { "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved\n capacity offering.
" + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved capacity offering.
" } }, "StartTime": { @@ -60559,7 +60575,7 @@ } }, "traits": { - "smithy.api#documentation": "Details about a reserved capacity offering for a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Details about a reserved capacity offering for a training plan offering.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The additional minutes beyond whole hours in the total duration for this reserved\n capacity.
" + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this reserved capacity.
" } }, "StartTime": { @@ -60688,7 +60704,7 @@ } }, "traits": { - "smithy.api#documentation": "Details of a reserved capacity for the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Details of a reserved capacity for the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
A resource catalog containing all of the resources of a specific resource type within\n a resource owner account. For an example on sharing the Amazon SageMaker Feature Store\n DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.\n
A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.
The ML compute instance type.
\nSageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting\n December 9th, 2022.
\n\n Amazon EC2 P4de instances\n (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance\n HBM2e GPU memory, which accelerate the speed of training ML models that need to be\n trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker\n supports ML training jobs on P4de instances (ml.p4de.24xlarge) to\n reduce model training time. The ml.p4de.24xlarge instances are\n available in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
\nUS West (Oregon) (us-west-2)
\nTo request quota limit increase and start using P4de instances, contact the SageMaker\n Training service team through your account team.
\nThe ML compute instance type.
SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.
Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.
The number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
" + "smithy.api#documentation": "The number of ML compute instances to use. For distributed training, provide a value greater than 1.
" } }, "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#VolumeSizeInGB", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The size of the ML storage volume that you want to provision.
\nML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.
When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
\nTo find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.
", + "smithy.api#documentation": "The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.
When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
The duration of time in seconds to retain configured resources in a warm pool for\n subsequent training jobs.
" + "smithy.api#documentation": "The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
" } }, "InstanceGroups": { @@ -60872,7 +60888,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the resources, including machine learning (ML) compute instances and ML\n storage volumes, to use for model training.
" + "smithy.api#documentation": "Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.
" } }, "com.amazonaws.sagemaker#ResourceConfigForUpdate": { @@ -60882,13 +60898,13 @@ "target": "com.amazonaws.sagemaker#KeepAlivePeriodInSeconds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The KeepAlivePeriodInSeconds value specified in the\n ResourceConfig to update.
The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.
The ResourceConfig to update KeepAlivePeriodInSeconds. Other\n fields in the ResourceConfig cannot be updated.
The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.
You have exceeded an SageMaker resource limit. For example, you might have too many\n training jobs created.
", + "smithy.api#documentation": "You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
", "smithy.api#error": "client" } }, @@ -60930,14 +60946,14 @@ "MaxNumberOfTrainingJobs": { "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", "traits": { - "smithy.api#documentation": "The maximum number of training jobs that a hyperparameter tuning job can\n launch.
" + "smithy.api#documentation": "The maximum number of training jobs that a hyperparameter tuning job can launch.
" } }, "MaxParallelTrainingJobs": { "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum number of concurrent training jobs that a hyperparameter tuning job can\n launch.
", + "smithy.api#documentation": "The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
", "smithy.api#required": {} } }, @@ -60949,7 +60965,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the maximum number of training jobs and parallel training jobs that a\n hyperparameter tuning job can launch.
" + "smithy.api#documentation": "Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
" } }, "com.amazonaws.sagemaker#ResourceNotFound": { @@ -61000,14 +61016,14 @@ "target": "com.amazonaws.sagemaker#ResourceSharingStrategy", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The strategy of how idle compute is shared within the cluster. The following are the\n options of strategies.
\n\n DontLend: entities do not lend idle compute.
\n Lend: entities can lend idle compute to entities that can\n borrow.
\n LendandBorrow: entities can lend idle compute and borrow idle compute\n from other entities.
Default is LendandBorrow.
The strategy of how idle compute is shared within the cluster. The following are the options of strategies.
DontLend: entities do not lend idle compute.
Lend: entities can lend idle compute to entities that can borrow.
LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.
Default is LendandBorrow.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of\n idle compute that the team is allowed to borrow.
\nDefault is 50.
The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.
Default is 50.
The instance type that the image version runs on.
\n\n JupyterServer apps only support the system value.
For KernelGateway apps, the system\n value is translated to ml.t3.medium. KernelGateway apps also support all other values for available\n instance types.
The instance type that the image version runs on.
JupyterServer apps only support the system value.
For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\n Resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that\n the version runs on.
\nWhen both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.
The default is Retain, which specifies to keep the data stored on the\n Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS\n volume.
The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.
Specify Delete to delete the data stored on the Amazon EFS volume.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -61276,7 +61292,7 @@ "ParallelismConfiguration": { "target": "com.amazonaws.sagemaker#ParallelismConfiguration", "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.
" + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration of the parent pipeline.
" } } }, @@ -61305,13 +61321,13 @@ "target": "com.amazonaws.sagemaker#MaximumRetryAttempts", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of times to retry the job. When the job is retried, it's\n SecondaryStatus is changed to STARTING.
The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.
The retry strategy to use when a training job fails due to an\n InternalServerError. RetryStrategy is specified as part of\n the CreateTrainingJob and CreateHyperParameterTuningJob\n requests. You can add the StoppingCondition parameter to the request to\n limit the training time for the complete job.
The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.
Batch size for each rolling step to provision capacity and turn on traffic on the new\n endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between\n 5% to 50% of the variant's total instance count.
", + "smithy.api#documentation": "Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.
", "smithy.api#required": {} } }, @@ -61361,7 +61377,7 @@ "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.
", + "smithy.api#documentation": "The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
", "smithy.api#required": {} } }, @@ -61374,7 +61390,7 @@ "RollbackMaximumBatchSize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.
" + "smithy.api#documentation": "Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.
" } } }, @@ -61506,7 +61522,7 @@ "target": "com.amazonaws.sagemaker#S3DataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.
If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains the\n data you want to use for model training. AugmentedManifestFile can only be\n used if the Channel's input mode is Pipe.
If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.
If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.
If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.
Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix/\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", + "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix/
A manifest might look like this: s3://bucketname/example.manifest
A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
This JSON is equivalent to the following S3Uri list:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
s3://customer_bucket/some/prefix/relative/path/custdata-N
The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.
Your input bucket must be located in same Amazon Web Services region as your training job.
", "smithy.api#required": {} } }, "S3DataDistributionType": { "target": "com.amazonaws.sagemaker#S3DataDistribution", "traits": { - "smithy.api#documentation": "If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.
If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.
\nIn distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.
If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.
If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.
A list of one or more attribute names to use that are found in a specified augmented\n manifest file.
" + "smithy.api#documentation": "A list of one or more attribute names to use that are found in a specified augmented manifest file.
" } }, "InstanceGroupNames": { @@ -61547,7 +61563,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the S3 data source.
\nYour input bucket must be in the same Amazon Web Services region as your training\n job.
" + "smithy.api#documentation": "Describes the S3 data source.
Your input bucket must be in the same Amazon Web Services region as your training job.
" } }, "com.amazonaws.sagemaker#S3DataType": { @@ -61588,7 +61604,7 @@ "target": "com.amazonaws.sagemaker#S3ModelDataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the type of ML model data to deploy.
\nIf you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri always ends\n with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is\n the ML model data to deploy.
Specifies the type of ML model data to deploy.
If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.
Specifies how the ML model data is prepared.
\nIf you choose Gzip and choose S3Object as the value of\n S3DataType, S3Uri identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.
If you choose None and chooose S3Object as the value of\n S3DataType, S3Uri identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of\n S3DataType, S3Uri identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object as the value of S3DataType,\n then SageMaker will split the key of the S3 object referenced by S3Uri\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.
If you choose S3Prefix as the value of S3DataType,\n then for each S3 object under the key name pefix referenced by\n S3Uri, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to /opt/ml/model) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights and\n s3://mybucket/model/weights/part1 and you specify\n s3://mybucket/model/ as the value of S3Uri and\n S3Prefix as the value of S3DataType, then it will\n result in name clash between /opt/ml/model/weights (a regular file)\n and /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in S3 console using\n folders. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure.
\nSpecifies how the ML model data is prepared.
If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.
If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.
If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:
If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.
If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.
Do not use any of the following as file names or directory names:
An empty or blank string
A string which contains null bytes
A string longer than 255 bytes
A single dot (.)
A double dot (..)
Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).
Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.
Specifies the access configuration file for the ML model. You can explicitly accept the\n model end-user license agreement (EULA) within the ModelAccessConfig. You are\n responsible for reviewing and complying with any applicable license terms and making sure\n they are acceptable for your use case before downloading or using a model.
Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the\n artifact locations.
" + "smithy.api#documentation": "The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the artifact locations.
" } }, "ETag": { @@ -61683,7 +61699,7 @@ } }, "traits": { - "smithy.api#documentation": "This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
" + "smithy.api#documentation": "This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.
To learn more about how custom templates are created, see Create custom worker task templates.
" } }, "com.amazonaws.sagemaker#S3StorageConfig": { @@ -61693,14 +61709,14 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following:\n s3://example-bucket/prefix/.
The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt\n any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:
\n \"kms:GenerateDataKey\"\n
The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:
\"kms:GenerateDataKey\"
The Amazon Simple Storage (Amazon S3) location and security configuration for\n OfflineStore.
The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.
Provides APIs for creating and managing SageMaker resources.
\nOther Resources:
\nProvides APIs for creating and managing SageMaker resources.
Other Resources:
", "smithy.api#title": "Amazon SageMaker Service", "smithy.api#xmlNamespace": { "uri": "http://sagemaker.amazonaws.com/doc/2017-05-13/" @@ -63965,13 +63981,13 @@ "InvocationsPerInstance": { "target": "com.amazonaws.sagemaker#Integer", "traits": { - "smithy.api#documentation": "The number of invocations sent to a model, normalized by InstanceCount\n in each ProductionVariant. 1/numberOfInstances is sent as the value on each\n request, where numberOfInstances is the number of active instances for the\n ProductionVariant behind the endpoint at the time of the request.
The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.
The interval of time taken by a model to respond as viewed from SageMaker.\n This interval includes the local communication times taken to send the request\n and to fetch the response from the container of a model and the time taken to\n complete the inference in the container.
" + "smithy.api#documentation": "The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
" } } }, @@ -64006,20 +64022,20 @@ "target": "com.amazonaws.sagemaker#ScheduleExpression", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A cron expression that describes details about the monitoring schedule.
\nThe supported cron expressions are:
\nIf you want to set the job to start every hour, use the following:
\n\n Hourly: cron(0 * ? * * *)\n
If you want to start the job daily:
\n\n cron(0 [00-23] ? * * *)\n
If you want to run the job one time, immediately, use the following\n keyword:
\n\n NOW\n
For example, the following are valid cron expressions:
\nDaily at noon UTC: cron(0 12 ? * * *)\n
Daily at midnight UTC: cron(0 0 ? * * *)\n
To support running every 6, 12 hours, the following are also supported:
\n\n cron(0 [00-23]/[01-24] ? * * *)\n
For example, the following are valid cron expressions:
\nEvery 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n
Every two hours starting at midnight: cron(0 0/2 ? * * *)\n
Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.
\nWe recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker AI will pick a time for running every day.
\nYou can also specify the keyword NOW to run the monitoring job immediately,\n one time, without recurring.
A cron expression that describes details about the monitoring schedule.
The supported cron expressions are:
If you want to set the job to start every hour, use the following:
Hourly: cron(0 * ? * * *)
If you want to start the job daily:
cron(0 [00-23] ? * * *)
If you want to run the job one time, immediately, use the following keyword:
NOW
For example, the following are valid cron expressions:
Daily at noon UTC: cron(0 12 ? * * *)
Daily at midnight UTC: cron(0 0 ? * * *)
To support running every 6, 12 hours, the following are also supported:
cron(0 [00-23]/[01-24] ? * * *)
For example, the following are valid cron expressions:
Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
Every two hours starting at midnight: cron(0 0/2 ? * * *)
Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.
Sets the start time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to monitor the five hours of data in your dataset that\n precede the start of each monitoring job, you would specify: \"-PT5H\".
The start time that you specify must not precede the end time that you specify by more\n than 24 hours. You specify the end time with the DataAnalysisEndTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: \"-PT5H\".
The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.
If you set ScheduleExpression to NOW, this parameter is required.
Sets the end time for a monitoring job window. Express this time as an offset to the\n times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the\n ScheduleExpression parameter. Specify this offset in ISO 8601 duration\n format. For example, if you want to end the window one hour before the start of each\n monitoring job, you would specify: \"-PT1H\".
The end time that you specify must not follow the start time that you specify by more\n than 24 hours. You specify the start time with the DataAnalysisStartTime\n parameter.
If you set ScheduleExpression to NOW, this parameter is\n required.
Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: \"-PT1H\".
The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.
If you set ScheduleExpression to NOW, this parameter is required.
List of the priority classes, PriorityClass, of the cluster policy. When\n specified, these class configurations define how tasks are queued.
List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.
When enabled, entities borrow idle compute based on their assigned\n FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve\n basis.
\nDefault is Enabled.
When enabled, entities borrow idle compute based on their assigned FairShareWeight.
When disabled, entities borrow idle compute based on a first-come first-serve basis.
Default is Enabled.
Cluster policy configuration. This policy is used for task prioritization and fair-share\n allocation. This helps prioritize critical workloads and distributes idle compute\n across entities.
" + "smithy.api#documentation": "Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
" } }, "com.amazonaws.sagemaker#SchedulerResourceStatus": { @@ -64203,7 +64219,7 @@ "target": "com.amazonaws.sagemaker#SearchResponse" }, "traits": { - "smithy.api#documentation": "Finds SageMaker resources that match a search query. Matching resources are returned as a list\n of SearchRecord objects in the response. You can sort the search results by any\n resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and\n timestamp.
\nThe Search API may provide access to otherwise restricted data. See Amazon SageMaker API\n Permissions: Actions, Permissions, and Resources Reference for more\n information.
\nFinds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.
A Boolean operator used to evaluate the search expression. If you want every conditional\n statement in all lists to be satisfied for the entire search expression to be true, specify\n And. If only a single conditional statement needs to be true for the entire\n search expression to be true, specify Or. The default value is\n And.
A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
A multi-expression that searches for the specified resource or resources in a search. All\n resource objects that satisfy the expression's condition are included in the search results.\n You must specify at least one subexpression, filter, or nested filter. A\n SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression\n comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of\n Boolean expressions using a list of resource properties. A nested filter is satisfied if a\n single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be\n nested in a list of search expression objects.
A Boolean operator: And or Or.
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
A Boolean operator: And or Or.
A Boolean conditional statement. Resources must satisfy this condition to be included in\n search results. You must provide at least one subexpression, filter, or nested filter. The\n maximum number of recursive SubExpressions, NestedFilters, and\n Filters that can be included in a SearchExpression object is\n 50.
A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
The name of the resource property used to sort the SearchResults. The default\n is LastModifiedTime.
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
If more than MaxResults resources match the specified\n SearchExpression, the response includes a NextToken. The\n NextToken can be passed to the next SearchRequest to continue\n retrieving results.
If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.
A cross account filter option. When the value is \"CrossAccount\" the search\n results will only include resources made discoverable to you from other accounts. When the\n value is \"SameAccount\" or null the search results will only include\n resources from your account. Default is null. For more information on searching\n for resources made discoverable to your account, see Search\n discoverable resources in the SageMaker Developer Guide. The maximum number of\n ResourceCatalogs viewable is 1000.
A cross account filter option. When the value is \"CrossAccount\" the search results will only include resources made discoverable to you from other accounts. When the value is \"SameAccount\" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.
If the result of the previous Search request was truncated, the response\n includes a NextToken. To retrieve the next set of results, use the token in the next\n request.
If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.
Searches for available training plan offerings based on specified criteria.
\nUsers search for available plan offerings based on their requirements (e.g.,\n instance type, count, start time, duration).
\nAnd then, they create a plan that best matches their needs using the ID of the\n plan offering they want to use.
\nFor more information about how to reserve GPU capacity for your SageMaker training jobs or\n SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see \n CreateTrainingPlan\n .
Searches for available training plan offerings based on specified criteria.
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).
And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.
For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see CreateTrainingPlan .
The type of instance you want to search for in the available training plan offerings.\n This field allows you to filter the search results based on the specific compute resources\n you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training\n plan offerings, specifying the instance type helps you find Reserved Instances that match\n your computational needs.
", - "smithy.api#required": {} + "smithy.api#documentation": "The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.
" } }, "InstanceCount": { "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceCount", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of instances you want to reserve in the training plan offerings. This allows\n you to specify the quantity of compute resources needed for your SageMaker training jobs or\n SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your\n requirements.
", - "smithy.api#required": {} + "smithy.api#documentation": "The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.
" } }, "StartTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter to search for training plan offerings with a start time after a specified\n date.
" + "smithy.api#documentation": "A filter to search for training plan offerings with a start time after a specified date.
" } }, "EndTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter to search for reserved capacity offerings with an end time before a specified\n date.
" + "smithy.api#documentation": "A filter to search for reserved capacity offerings with an end time before a specified date.
" } }, "DurationHours": { @@ -64500,7 +64512,7 @@ "target": "com.amazonaws.sagemaker#SageMakerResourceNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the\n offerings.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
Contains a secondary status information from a training\n job.
\nStatus might be one of the following secondary statuses:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
A timestamp that shows when the training job transitioned to the current secondary\n status state.
", + "smithy.api#documentation": "A timestamp that shows when the training job transitioned to the current secondary status state.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.
" + "smithy.api#documentation": "A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
" } }, "StatusMessage": { "target": "com.amazonaws.sagemaker#StatusMessage", "traits": { - "smithy.api#documentation": "A detailed description of the progress within a secondary status.\n
\nSageMaker provides secondary statuses and status messages that apply to each of\n them:
\nStarting the training job.
\nLaunching requested ML\n instances.
\nInsufficient\n capacity error from EC2 while launching instances,\n retrying!
\nLaunched\n instance was unhealthy, replacing it!
\nPreparing the instances for training.
\nTraining\n image download completed. Training in\n progress.
\nStatus messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.
\nTo have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,\n at the start of a training job, you might see the following:
\n TrainingJobStatus - InProgress
\n SecondaryStatus - Training
\n StatusMessage - Downloading the training image
A detailed description of the progress within a secondary status.
SageMaker provides secondary statuses and status messages that apply to each of them:
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Training image download completed. Training in progress.
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:
TrainingJobStatus - InProgress
SecondaryStatus - Training
StatusMessage - Downloading the training image
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the\n training job has transitioned through. A training job can be in one of several states,\n for example, starting, downloading, training, or uploading. Within each state, there are\n a number of intermediate states. For example, within the starting state, SageMaker could be\n starting the training job or launching the ML instances. These transitional states are\n referred to as the job's secondary\n status.\n
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.
This field is required if the steps you specify for\n SelectedSteps depend on output collaterals from any non-specified pipeline\n steps. For more information, see Selective\n Execution for Pipeline Steps.
The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.
This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.
A list of pipeline steps to run. All step(s) in all path(s) between\n two selected steps should be included.
", + "smithy.api#documentation": "A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
", "smithy.api#required": {} } } @@ -64793,7 +64805,7 @@ } ], "traits": { - "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step failed, along with a\n message describing why. When a callback step is run, the pipeline generates a callback\n token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" + "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" } }, "com.amazonaws.sagemaker#SendPipelineExecutionStepFailureRequest": { @@ -64816,7 +64828,7 @@ "ClientRequestToken": { "target": "com.amazonaws.sagemaker#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "smithy.api#idempotencyToken": {} } } @@ -64859,7 +64871,7 @@ } ], "traits": { - "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step succeeded and provides a\n list of the step's output parameters. When a callback step is run, the pipeline generates\n a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" + "smithy.api#documentation": "Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" } }, "com.amazonaws.sagemaker#SendPipelineExecutionStepSuccessRequest": { @@ -64882,7 +64894,7 @@ "ClientRequestToken": { "target": "com.amazonaws.sagemaker#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than one time.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "smithy.api#idempotencyToken": {} } } @@ -64954,12 +64966,12 @@ "ProvisionedProductStatusMessage": { "target": "com.amazonaws.sagemaker#ProvisionedProductStatusMessage", "traits": { - "smithy.api#documentation": "The current status of the product.
\n\n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
\n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
\n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
\n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
The current status of the product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
Details of a provisioned service catalog product. For information about service catalog,\n see What is Amazon Web Services Service\n Catalog.
" + "smithy.api#documentation": "Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
" } }, "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails": { @@ -64993,7 +65005,7 @@ } }, "traits": { - "smithy.api#documentation": "Details that you specify to provision a service catalog product. For information about\n service catalog, see What is Amazon Web Services Service\n Catalog.
" + "smithy.api#documentation": "Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
" } }, "com.amazonaws.sagemaker#ServiceCatalogProvisioningUpdateDetails": { @@ -65013,7 +65025,7 @@ } }, "traits": { - "smithy.api#documentation": "Details that you specify to provision a service catalog product. \n For information about service catalog, see What is Amazon Web Services Service Catalog.\n
" + "smithy.api#documentation": "Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
" } }, "com.amazonaws.sagemaker#SessionChainingConfig": { @@ -65022,12 +65034,12 @@ "EnableSessionTagChaining": { "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", "traits": { - "smithy.api#documentation": "Set to True to allow SageMaker to extract session tags from a training job\n creation role and reuse these tags when assuming the training job execution role.
Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.
Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your training job to\n request temporary, limited-privilege credentials to tenants. For more information, see\n Attribute-based access control (ABAC) for multi-tenancy training.
" + "smithy.api#documentation": "Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see Attribute-based access control (ABAC) for multi-tenancy training.
" } }, "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { @@ -65046,7 +65058,7 @@ "target": "com.amazonaws.sagemaker#ModelVariantName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The name of the production variant, which takes all the inference requests.\n
", + "smithy.api#documentation": "The name of the production variant, which takes all the inference requests.
", "smithy.api#required": {} } }, @@ -65060,7 +65072,7 @@ } }, "traits": { - "smithy.api#documentation": "\n The configuration of ShadowMode inference experiment type, which specifies a production variant\n to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n
The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.
\n The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n
", + "smithy.api#documentation": "The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
", "smithy.api#required": {} } } @@ -65105,24 +65117,24 @@ "NotebookOutputOption": { "target": "com.amazonaws.sagemaker#NotebookOutputOption", "traits": { - "smithy.api#documentation": "Whether to include the notebook cell output when sharing the notebook. The default is\n Disabled.
Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
When NotebookOutputOption is Allowed, the Amazon S3\n bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon Web Services Key\n Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the\n Amazon S3 bucket.
When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain API\n is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing isn't\n allowed.
Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.
A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.
\nThe Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.
The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
", + "smithy.api#documentation": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
" + "smithy.api#documentation": "Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
" } }, "com.amazonaws.sagemaker#SourceAlgorithmList": { @@ -65586,13 +65598,13 @@ "target": "com.amazonaws.sagemaker#Cidrs", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of one to ten Classless Inter-Domain Routing (CIDR) values.
\nMaximum: Ten CIDR values
\nThe following Length Constraints apply to individual CIDR values in\n the CIDR value list.
\nA list of one to ten Classless Inter-Domain Routing (CIDR) values.
Maximum: Ten CIDR values
The following Length Constraints apply to individual CIDR values in the CIDR value list.
A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an\n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" + "smithy.api#documentation": "A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" } }, "com.amazonaws.sagemaker#SourceType": { @@ -65625,7 +65637,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.
" + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.
" } }, "com.amazonaws.sagemaker#SpaceArn": { @@ -65647,7 +65659,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.
" + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.
" } } }, @@ -65732,7 +65744,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it\n down.
" + "smithy.api#documentation": "The time that SageMaker waits after the application becomes idle before shutting it down.
" } } }, @@ -65755,7 +65767,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.
" + "smithy.api#documentation": "Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.
" } } }, @@ -65803,7 +65815,7 @@ "AppType": { "target": "com.amazonaws.sagemaker#AppType", "traits": { - "smithy.api#documentation": "The type of app created within the space.
\nIf using the \n UpdateSpace API, you can't change the app type of your\n space by specifying a different value for this field.
" + "smithy.api#documentation": "The type of app created within the space.
If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.
" } }, "SpaceStorageSettings": { @@ -65812,10 +65824,16 @@ "smithy.api#documentation": "The storage settings for a space.
" } }, + "SpaceManagedResources": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:
The user profile that possesses the space.
The app that the space contains.
A file system, created by you, that you assign to a space for an Amazon SageMaker AI\n Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" + "smithy.api#documentation": "A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" } } }, @@ -66074,7 +66092,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.
\nSpecify either the stairs or phases traffic pattern.
" + "smithy.api#documentation": "Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.
Specify either the stairs or phases traffic pattern.
" } }, "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { @@ -66229,7 +66247,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a previously stopped monitoring schedule.
\nBy default, when you successfully create a new schedule, the status of a monitoring\n schedule is scheduled.
Starts a previously stopped monitoring schedule.
By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.
Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook\n instance's status must be InService before you can connect to your Jupyter\n notebook.
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -66345,7 +66363,7 @@ "ParallelismConfiguration": { "target": "com.amazonaws.sagemaker#ParallelismConfiguration", "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
" } }, "SelectiveExecutionConfig": { @@ -66539,7 +66557,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a model compilation job.
\nTo stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.
\nWhen it receives a StopCompilationJob request, Amazon SageMaker AI changes the\n CompilationJobStatus of the job to Stopping. After Amazon\n SageMaker stops the job, it sets the CompilationJobStatus to\n Stopped.
Stops a model compilation job.
To stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob request, Amazon SageMaker AI changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.
Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.
\nAll model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.
\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n
\n\n Promote - Promote the shadow variant to a production variant
\n Remove - Delete the variant
\n Retain - Keep the variant as it is
Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:
Promote - Promote the shadow variant to a production variant
Remove - Delete the variant
Retain - Keep the variant as it is
\n An array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n
An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.
\n The desired state of the experiment after stopping. The possible states are the following:\n
\n\n Completed: The experiment completed successfully
\n Cancelled: The experiment was canceled
The desired state of the experiment after stopping. The possible states are the following:
Completed: The experiment completed successfully
Cancelled: The experiment was canceled
Stops a running labeling job. A job that is stopped cannot be restarted. Any results\n obtained before the job is stopped are placed in the Amazon S3 output bucket.
" + "smithy.api#documentation": "Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.
" } }, "com.amazonaws.sagemaker#StopLabelingJobRequest": { @@ -66891,7 +66909,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the\n ML storage volume. SageMaker AI stops charging you for the ML compute instance when\n you call StopNotebookInstance.
To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n
Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI stops charging you for the ML compute instance when you call StopNotebookInstance.
To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
Stops a pipeline execution.
\n\n Callback Step\n
\nA pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
\n\n Lambda Step\n
\nA pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.
Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n operation. An idempotent operation completes no more than once.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -67049,7 +67067,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.
When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.
Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.
When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.
Stops a batch transform job.
\nWhen Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
Stops a batch transform job.
When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.
\nFor compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.
The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.
The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.
When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
The maximum length of time, in seconds, that a training or compilation job can be\n pending before it is stopped.
\nWhen working with training jobs that use capacity from training\n plans, not all Pending job states count against the\n MaxPendingTimeInSeconds limit. The following scenarios do not\n increment the MaxPendingTimeInSeconds counter:
The plan is in a Scheduled state: Jobs queued (in\n Pending status) before a plan's start date (waiting for\n scheduled start time)
Between capacity reservations: Jobs temporarily back to\n Pending status between two capacity reservation\n periods
\n MaxPendingTimeInSeconds only increments when jobs are actively\n waiting for capacity in an Active plan.
The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.
When working with training jobs that use capacity from training plans, not all Pending job states count against the MaxPendingTimeInSeconds limit. The following scenarios do not increment the MaxPendingTimeInSeconds counter:
The plan is in a Scheduled state: Jobs queued (in Pending status) before a plan's start date (waiting for scheduled start time)
Between capacity reservations: Jobs temporarily back to Pending status between two capacity reservation periods
MaxPendingTimeInSeconds only increments when jobs are actively waiting for capacity in an Active plan.
Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\n ends the job. Use this API to cap costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nSpecifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle\n Configurations are immutable.
" + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
" } }, "StudioLifecycleConfigAppType": { @@ -67394,7 +67412,7 @@ "HiddenAppTypes": { "target": "com.amazonaws.sagemaker#HiddenAppTypesList", "traits": { - "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation\n pane.
" + "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation pane.
" } }, "HiddenInstanceTypes": { @@ -67411,7 +67429,7 @@ } }, "traits": { - "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" } }, "com.amazonaws.sagemaker#SubnetId": { @@ -67491,22 +67509,12 @@ "PropertyNameQuery": { "target": "com.amazonaws.sagemaker#PropertyNameQuery", "traits": { - "smithy.api#documentation": "Defines a property name hint. Only property names that begin with the specified hint are\n included in the response.
" + "smithy.api#documentation": "Defines a property name hint. Only property names that begin with the specified hint are included in the response.
" } } }, "traits": { - "smithy.api#documentation": "Specified in the GetSearchSuggestions request. Limits the property names that are included in the\n response.
" - } - }, - "com.amazonaws.sagemaker#SynthesizedJsonHumanLoopActivationConditions": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10240 - }, - "smithy.api#mediaType": "application/json" + "smithy.api#documentation": "Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.
" } }, "com.amazonaws.sagemaker#TableFormat": { @@ -67557,39 +67565,39 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job V2. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
These column keys may not include the target column.
\nIn ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
These column keys may not include the target column.
In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.
Generates possible candidates without training the models. A model candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.
" + "smithy.api#documentation": "Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
" } }, "ProblemType": { "target": "com.amazonaws.sagemaker#ProblemType", "traits": { - "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2. For more information, see \n SageMaker Autopilot problem types.
\nYou must either specify the type of supervised learning problem in\n ProblemType and provide the AutoMLJobObjective metric, or none at all.
The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see SageMaker Autopilot problem types.
You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.
The name of the target variable in supervised learning, usually represented by\n 'y'.
", + "smithy.api#documentation": "The name of the target variable in supervised learning, usually represented by 'y'.
", "smithy.api#required": {} } }, "SampleWeightAttributeName": { "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", "traits": { - "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" + "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.
Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.
Support for sample weights is available in Ensembling mode only.
" } } }, @@ -67603,7 +67611,7 @@ "ProblemType": { "target": "com.amazonaws.sagemaker#ProblemType", "traits": { - "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2 (Binary Classification, Multiclass Classification, Regression). For more\n information, see \n SageMaker Autopilot problem types.
" + "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see SageMaker Autopilot problem types.
" } } }, @@ -67632,7 +67640,7 @@ } }, "traits": { - "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.
\nYou can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.
\nFor more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.
" + "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
" } }, "com.amazonaws.sagemaker#TagKey": { @@ -67950,7 +67958,7 @@ "target": "com.amazonaws.sagemaker#TargetPlatformOs", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a target platform OS.
\n\n LINUX: Linux-based operating systems.
\n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n
Specifies a target platform OS.
LINUX: Linux-based operating systems.
ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, \"CompilerOptions\": {'ANDROID_PLATFORM': 28}
Specifies a target platform architecture.
\n\n X86_64: 64-bit version of the x86 instruction set.
\n X86: 32-bit version of the x86 instruction set.
\n ARM64: ARMv8 64-bit CPU.
\n ARM_EABIHF: ARMv7 32-bit, Hard Float.
\n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.
Specifies a target platform architecture.
X86_64: 64-bit version of the x86 instruction set.
X86: 32-bit version of the x86 instruction set.
ARM64: ARMv8 64-bit CPU.
ARM_EABIHF: ARMv7 32-bit, Hard Float.
ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.
Specifies a target platform accelerator (optional).
\n\n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options
\n MALI: ARM Mali graphics processor
\n INTEL_GRAPHICS: Integrated Intel graphics
Specifies a target platform accelerator (optional).
NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options
MALI: ARM Mali graphics processor
INTEL_GRAPHICS: Integrated Intel graphics
Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.
A target tracking scaling policy. Includes support for predefined or customized metrics.
\nWhen using the PutScalingPolicy API,\n this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
A target tracking scaling policy. Includes support for predefined or customized metrics.
When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI\n image created on the instance.
" + "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
" } } }, @@ -68198,7 +68206,7 @@ "LocalPath": { "target": "com.amazonaws.sagemaker#DirectoryPath", "traits": { - "smithy.api#documentation": "Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
How long a job is allowed to run, or how many candidates a job is allowed to\n generate.
" + "smithy.api#documentation": "How long a job is allowed to run, or how many candidates a job is allowed to generate.
" } }, "ContentColumn": { "target": "com.amazonaws.sagemaker#ContentColumn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column.
", + "smithy.api#documentation": "The name of the column used to provide the sentences to be classified. It should not be the same as the target column.
", "smithy.api#required": {} } }, @@ -68253,13 +68261,13 @@ "target": "com.amazonaws.sagemaker#TargetLabelColumn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the\n content column.
", + "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the content column.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the text classification problem\n type.
" + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the text classification problem type.
" } }, "com.amazonaws.sagemaker#TextGenerationHyperParameterKey": { @@ -68303,19 +68311,19 @@ "CompletionCriteria": { "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria", "traits": { - "smithy.api#documentation": "How long a fine-tuning job is allowed to run. For TextGenerationJobConfig\n problem types, the MaxRuntimePerTrainingJobInSeconds attribute of\n AutoMLJobCompletionCriteria defaults to 72h (259200s).
How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).
The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon7BInstruct.
The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.
The hyperparameters used to configure and optimize the learning process of the base\n model. You can set any combination of the following hyperparameters for all base models.\n For more information on each supported hyperparameter, see Optimize\n the learning process of your text generation models with hyperparameters.
\n\n \"epochCount\": The number of times the model goes through the entire\n training dataset. Its value should be a string containing an integer value within the\n range of \"1\" to \"10\".
\n \"batchSize\": The number of data samples used in each iteration of\n training. Its value should be a string containing an integer value within the range\n of \"1\" to \"64\".
\n \"learningRate\": The step size at which a model's parameters are\n updated during training. Its value should be a string containing a floating-point\n value within the range of \"0\" to \"1\".
\n \"learningRateWarmupSteps\": The number of training steps during which\n the learning rate gradually increases before reaching its target or maximum value.\n Its value should be a string containing an integer value within the range of \"0\" to\n \"250\".
Here is an example where all four hyperparameters are configured.
\n\n { \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\",\n \"learningRateWarmupSteps\": \"10\" }\n
The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.
\"epochCount\": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of \"1\" to \"10\".
\"batchSize\": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of \"1\" to \"64\".
\"learningRate\": The step size at which a model's parameters are updated during training. Its value should be a string containing a floating-point value within the range of \"0\" to \"1\".
\"learningRateWarmupSteps\": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of \"0\" to \"250\".
Here is an example where all four hyperparameters are configured.
{ \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\", \"learningRateWarmupSteps\": \"10\" }
The collection of settings used by an AutoML job V2 for the text generation problem\n type.
\nThe text generation models that support fine-tuning in Autopilot are currently accessible\n exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported\n Regions.
\nThe collection of settings used by an AutoML job V2 for the text generation problem type.
The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.
The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + "smithy.api#documentation": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
" } }, "ProvisionedWriteCapacityUnits": { "target": "com.amazonaws.sagemaker#CapacityUnit", "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
" } } }, "traits": { - "smithy.api#documentation": "Used to set feature group throughput configuration. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.
The mode used for your feature group throughput: ON_DEMAND or\n PROVISIONED.
The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + "smithy.api#documentation": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
" } }, "ProvisionedWriteCapacityUnits": { "target": "com.amazonaws.sagemaker#CapacityUnit", "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
\nThis field is not applicable for on-demand feature groups.
" + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
This field is not applicable for on-demand feature groups.
" } } }, "traits": { - "smithy.api#documentation": "Active throughput configuration of the feature group. There are two modes:\n ON_DEMAND and PROVISIONED. With on-demand mode, you are\n charged for data reads and writes that your application performs on your feature group. You\n do not need to specify read and write throughput because Feature Store accommodates your\n workloads as they ramp up and down. You can switch a feature group to on-demand only once\n in a 24 hour period. With provisioned throughput mode, you specify the read and write\n capacity per second that you expect your application to require, and you are billed based\n on those limits. Exceeding provisioned throughput will result in your requests being\n throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that\n are offline-only, or use the \n Standard\n tier online store.
Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.
Target throughput mode of the feature group. Throughput update is an asynchronous\n operation, and the outcome should be monitored by polling LastUpdateStatus\n field in DescribeFeatureGroup response. You cannot update a feature group's\n throughput while another update is in progress.
Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group's throughput while another update is in progress.
For provisioned feature groups with online store enabled, this indicates the read\n throughput you are billed for and can consume without throttling.
" + "smithy.api#documentation": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.
" } }, "ProvisionedWriteCapacityUnits": { "target": "com.amazonaws.sagemaker#CapacityUnit", "traits": { - "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for\n and can consume without throttling.
" + "smithy.api#documentation": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.
" } } }, "traits": { - "smithy.api#documentation": "The new throughput configuration for the feature group. You can switch between on-demand\n and provisioned modes or update the read / write capacity of provisioned feature groups.\n You can switch a feature group to on-demand only once in a 24 hour period.
" + "smithy.api#documentation": "The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.
" } }, "com.amazonaws.sagemaker#ThroughputMode": { @@ -68456,7 +68464,7 @@ "target": "com.amazonaws.sagemaker#TargetAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column representing the target variable that you want to predict for\n each item in your dataset. The data type of the target variable must be numerical.
", + "smithy.api#documentation": "The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.
", "smithy.api#required": {} } }, @@ -68464,7 +68472,7 @@ "target": "com.amazonaws.sagemaker#TimestampAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column indicating a point in time at which the target value of a given\n item is recorded.
", + "smithy.api#documentation": "The name of the column indicating a point in time at which the target value of a given item is recorded.
", "smithy.api#required": {} } }, @@ -68472,14 +68480,14 @@ "target": "com.amazonaws.sagemaker#ItemIdentifierAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the column that represents the set of item identifiers for which you want to\n predict the target value.
", + "smithy.api#documentation": "The name of the column that represents the set of item identifiers for which you want to predict the target value.
", "smithy.api#required": {} } }, "GroupingAttributeNames": { "target": "com.amazonaws.sagemaker#GroupingAttributeNames", "traits": { - "smithy.api#documentation": "A set of columns names that can be grouped with the item identifier column to create a\n composite key for which a target value is predicted.
" + "smithy.api#documentation": "A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.
" } } }, @@ -68493,7 +68501,7 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "A URL to the Amazon S3 data source containing additional selected features that\n complement the target, itemID, timestamp, and grouped columns set in\n TimeSeriesConfig. When not provided, the AutoML job V2 includes all the\n columns from the original dataset that are not already declared in\n TimeSeriesConfig. If provided, the AutoML job V2 only considers these\n additional columns as a complement to the ones declared in\n TimeSeriesConfig.
You can input FeatureAttributeNames (optional) in JSON format as shown\n below:
\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown\n below:
\n\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n
Autopilot supports the following data types: numeric, categorical,\n text, and datetime.
These column keys must not include any column set in\n TimeSeriesConfig.
A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.
You can input FeatureAttributeNames (optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
Autopilot supports the following data types: numeric, categorical, text, and datetime.
These column keys must not include any column set in TimeSeriesConfig.
The frequency of predictions in a forecast.
\nValid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H\n (Hour), and min (Minute). For example, 1D indicates every day and\n 15min indicates every 15 minutes. The value of a frequency must not overlap\n with the next larger frequency. For example, you must use a frequency of 1H\n instead of 60min.
The valid values for each frequency are the following:
\nMinute - 1-59
\nHour - 1-23
\nDay - 1-6
\nWeek - 1-4
\nMonth - 1-11
\nYear - 1
\nThe frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.
The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4\n of the time-steps in the dataset.
", + "smithy.api#documentation": "The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.
", "smithy.api#required": {} } }, "ForecastQuantiles": { "target": "com.amazonaws.sagemaker#ForecastQuantiles", "traits": { - "smithy.api#documentation": "The quantiles used to train the model for forecasts at a specified quantile. You can\n specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of\n 0.01 or higher. Up to five forecast quantiles can be specified. When\n ForecastQuantiles is not provided, the AutoML job uses the quantiles p10,\n p50, and p90 as default.
The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.
The transformations modifying specific attributes of the time-series, such as filling\n strategies for missing values.
" + "smithy.api#documentation": "The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.
" } }, "TimeSeriesConfig": { @@ -68538,7 +68546,7 @@ "HolidayConfig": { "target": "com.amazonaws.sagemaker#HolidayConfig", "traits": { - "smithy.api#documentation": "The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.
" + "smithy.api#documentation": "The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.
" } }, "CandidateGenerationConfig": { @@ -68546,7 +68554,7 @@ } }, "traits": { - "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the time-series forecasting\n problem type.
" + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.
" } }, "com.amazonaws.sagemaker#TimeSeriesForecastingSettings": { @@ -68555,13 +68563,13 @@ "Status": { "target": "com.amazonaws.sagemaker#FeatureStatus", "traits": { - "smithy.api#documentation": "Describes whether time series forecasting is enabled or disabled in the Canvas\n application.
" + "smithy.api#documentation": "Describes whether time series forecasting is enabled or disabled in the Canvas application.
" } }, "AmazonForecastRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default,\n Canvas uses the execution role specified in the UserProfile that launches the\n Canvas application. If an execution role is not specified in the UserProfile,\n Canvas uses the execution role specified in the Domain that owns the\n UserProfile. To allow time series forecasting, this IAM role should have the\n AmazonSageMakerCanvasForecastAccess policy attached and\n forecast.amazonaws.com added in the trust relationship as a service\n principal.
The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
A key value pair defining the filling method for a column, where the key is the column\n name and the value is an object which defines the filling logic. You can specify multiple\n filling methods for a single column.
\nThe supported filling methods and their corresponding options are:
\n\n frontfill: none (Supported only for target\n column)
\n middlefill: zero, value,\n median, mean, min, max\n
\n backfill: zero, value, median,\n mean, min, max\n
\n futurefill: zero, value,\n median, mean, min, max\n
To set a filling method to a specific value, set the fill parameter to the chosen\n filling method value (for example \"backfill\" : \"value\"), and define the\n filling value in an additional parameter prefixed with \"_value\". For example, to set\n backfill to a value of 2, you must include two parameters:\n \"backfill\": \"value\" and \"backfill_value\":\"2\".
A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.
The supported filling methods and their corresponding options are:
frontfill: none (Supported only for target column)
middlefill: zero, value, median, mean, min, max
backfill: zero, value, median, mean, min, max
futurefill: zero, value, median, mean, min, max
To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example \"backfill\" : \"value\"), and define the filling value in an additional parameter prefixed with \"_value\". For example, to set backfill to a value of 2, you must include two parameters: \"backfill\": \"value\" and \"backfill_value\":\"2\".
A key value pair defining the aggregation method for a column, where the key is the\n column name and the value is the aggregation method.
\nThe supported aggregation methods are sum (default), avg,\n first, min, max.
Aggregation is only supported for the target column.
\nA key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.
The supported aggregation methods are sum (default), avg, first, min, max.
Aggregation is only supported for the target column.
Transformations allowed on the dataset. Supported transformations are\n Filling and Aggregation. Filling specifies how to\n add values to missing values in the dataset. Aggregation defines how to\n aggregate data that does not align with forecast frequency.
Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.
The total number of matching results. This value may be exact or an estimate, depending on\n the Relation field.
The total number of matching results. This value may be exact or an estimate, depending on the Relation field.
Indicates the relationship between the returned Value and the actual total\n number of matching results. Possible values are:
\n EqualTo: The Value is the exact count of matching\n results.
\n GreaterThanOrEqualTo: The Value is a lower bound of the\n actual count of matching results.
Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:
EqualTo: The Value is the exact count of matching results.
GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.
Represents the total number of matching results and indicates how accurate that count\n is.
\nThe Value field provides the count, which may be exact or estimated. The\n Relation field indicates whether it's an exact figure or a lower bound. This\n helps understand the full scope of search results, especially when dealing with large result\n sets.
Represents the total number of matching results and indicates how accurate that count is.
The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.
Traffic routing strategy type.
\n\n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single\n step.
\n CANARY: Endpoint traffic shifts to the new fleet in two steps.\n The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.
\n LINEAR: Endpoint traffic shifts to the new fleet in n steps of a\n configurable size.
Traffic routing strategy type.
ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.
The waiting time (in seconds) between incremental steps to turn on traffic on the new\n endpoint fleet.
", + "smithy.api#documentation": "The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
", "smithy.api#required": {} } }, "CanarySize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "Batch size for the first step to turn on traffic on the new endpoint fleet.\n Value must be less than or equal to 50% of the variant's total instance\n count.
Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet.\n Value must be 10-50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.
Defines the traffic routing strategy during an endpoint deployment to shift traffic\n from the old fleet to the new fleet.
" + "smithy.api#documentation": "Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
" } }, "com.amazonaws.sagemaker#TrafficRoutingConfigType": { @@ -69046,19 +69054,19 @@ "target": "com.amazonaws.sagemaker#TrainingRepositoryAccessMode", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The method that your training job will use to gain access to the images in your\n private Docker registry. For access to an image in a private Docker registry, set to\n Vpc.
The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.
An object containing authentication information for a private Docker registry\n containing your training images.
" + "smithy.api#documentation": "An object containing authentication information for a private Docker registry containing your training images.
" } } }, "traits": { - "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training\n job.
" + "smithy.api#documentation": "The configuration to use an image from a private Docker registry for a training job.
" } }, "com.amazonaws.sagemaker#TrainingInputMode": { @@ -69084,7 +69092,7 @@ } }, "traits": { - "smithy.api#documentation": "The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.
\n\n Pipe mode\n
\nIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.
\n File mode\n
\nIf an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.
\nFor distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.
\n\n FastFile mode\n
\nIf an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.
\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.
The training input mode that the algorithm supports. For more information about input modes, see Algorithms.
Pipe mode
If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.
File mode
If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.
You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.
For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.
FastFile mode
If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.
FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
" } }, "LabelingJobArn": { @@ -69790,19 +69798,19 @@ "ModelArtifacts": { "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { - "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model\n artifacts.
" + "smithy.api#documentation": "Information about the Amazon S3 location that is configured for storing model artifacts.
" } }, "TrainingJobStatus": { "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "The status of the\n training\n job.
\nTraining job statuses are:
\n\n InProgress - The training is in progress.
\n Completed - The training job has completed.
\n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.
\n Stopping - The training job is stopping.
\n Stopped - The training job has stopped.
For\n more detailed information, see SecondaryStatus.
The status of the training job.
Training job statuses are:
InProgress - The training is in progress.
Completed - The training job has completed.
Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
Stopping - The training job is stopping.
Stopped - The training job has stopped.
For more detailed information, see SecondaryStatus.
Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of them:
Starting - Starting the training job.
Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
The Amazon Web Services Identity and Access Management (IAM) role configured for the\n training job.
" + "smithy.api#documentation": "The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
" } }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "An array of Channel objects that describes each data input\n channel.
Your input must be in the same Amazon Web Services region as your training job.
" + "smithy.api#documentation": "An array of Channel objects that describes each data input channel.
Your input must be in the same Amazon Web Services region as your training job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.
" + "smithy.api#documentation": "The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
" } }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.
" + "smithy.api#documentation": "Resources, including ML compute instances and ML storage volumes, that are configured for model training.
" } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.
Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
A timestamp that indicates when the status of the training job was last\n modified.
" + "smithy.api#documentation": "A timestamp that indicates when the status of the training job was last modified.
" } }, "SecondaryStatusTransitions": { "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", "traits": { - "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned\n through.
" + "smithy.api#documentation": "A history of all of the secondary statuses that the training job has transitioned through.
" } }, "FinalMetricDataList": { "target": "com.amazonaws.sagemaker#FinalMetricDataList", "traits": { - "smithy.api#documentation": "A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.
" + "smithy.api#documentation": "A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.
" } }, "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.
If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" + "smithy.api#documentation": "When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" } }, "CheckpointConfig": { @@ -69961,13 +69969,13 @@ "RetryStrategy": { "target": "com.amazonaws.sagemaker#RetryStrategy", "traits": { - "smithy.api#documentation": "The number of times to retry the job when the job fails due to an\n InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" } } }, @@ -70005,7 +70013,7 @@ "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of Channel objects, each of which specifies an input\n source.
An array of Channel objects, each of which specifies an input source.
the path to the S3 bucket where you want to store model artifacts. SageMaker creates\n subfolders for the artifacts.
", + "smithy.api#documentation": "the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
", "smithy.api#required": {} } }, @@ -70021,7 +70029,7 @@ "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use for\n model training.
", + "smithy.api#documentation": "The resources, including the ML compute instances and ML storage volumes, to use for model training.
", "smithy.api#required": {} } }, @@ -70029,7 +70037,7 @@ "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.
\nTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.
", + "smithy.api#documentation": "Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
", "smithy.api#required": {} } } @@ -70143,36 +70151,36 @@ "Completed": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "The number of completed training jobs launched by the hyperparameter tuning\n job.
" + "smithy.api#documentation": "The number of completed training jobs launched by the hyperparameter tuning job.
" } }, "InProgress": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "The number of in-progress training jobs launched by a hyperparameter tuning\n job.
" + "smithy.api#documentation": "The number of in-progress training jobs launched by a hyperparameter tuning job.
" } }, "RetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.
" + "smithy.api#documentation": "The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
" } }, "NonRetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.
" + "smithy.api#documentation": "The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
" } }, "Stopped": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.
" + "smithy.api#documentation": "The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
" } } }, "traits": { - "smithy.api#documentation": "The numbers of training jobs launched by a hyperparameter tuning job, categorized by\n status.
" + "smithy.api#documentation": "The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
" } }, "com.amazonaws.sagemaker#TrainingJobStepMetadata": { @@ -70225,7 +70233,7 @@ "TrainingEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).
A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).
The Amazon Resource Name (ARN); of the training plan associated with this training job.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
The Amazon Resource Name (ARN); of the training plan associated with this training job.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
A filter to apply when listing or searching for training plans.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
A filter to apply when listing or searching for training plans.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan\n offering.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
The requested start time that the user specified when searching for the training plan\n offering.
" + "smithy.api#documentation": "The requested start time that the user specified when searching for the training plan offering.
" } }, "RequestedEndTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "The requested end time that the user specified when searching for the training plan\n offering.
" + "smithy.api#documentation": "The requested end time that the user specified when searching for the training plan offering.
" } }, "DurationHours": { @@ -70405,7 +70413,7 @@ "DurationMinutes": { "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan\n offering.
" + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan offering.
" } }, "UpfrontFee": { @@ -70423,12 +70431,12 @@ "ReservedCapacityOfferings": { "target": "com.amazonaws.sagemaker#ReservedCapacityOfferings", "traits": { - "smithy.api#documentation": "A list of reserved capacity offerings associated with this training plan\n offering.
" + "smithy.api#documentation": "A list of reserved capacity offerings associated with this training plan offering.
" } } }, "traits": { - "smithy.api#documentation": "Details about a training plan offering.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Details about a training plan offering.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The current status of the training plan (e.g., Pending, Active, Expired). To see the\n complete list of status values available for a training plan, refer to the\n Status attribute within the \n TrainingPlanSummary\n object.
The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
A message providing additional information about the current status of the training\n plan.
" + "smithy.api#documentation": "A message providing additional information about the current status of the training plan.
" } }, "DurationHours": { @@ -70584,7 +70592,7 @@ "DurationMinutes": { "target": "com.amazonaws.sagemaker#TrainingPlanDurationMinutes", "traits": { - "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training\n plan.
" + "smithy.api#documentation": "The additional minutes beyond whole hours in the total duration for this training plan.
" } }, "StartTime": { @@ -70632,18 +70640,18 @@ "TargetResources": { "target": "com.amazonaws.sagemaker#SageMakerResourceNames", "traits": { - "smithy.api#documentation": "The target resources (e.g., training jobs, HyperPod clusters) that can use this training\n plan.
\nTraining plans are specific to their target resource.
\nA training plan designed for SageMaker training jobs can only be used to schedule and\n run training jobs.
\nA training plan for HyperPod clusters can be used exclusively to provide\n compute resources to a cluster's instance group.
\nThe target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
A list of reserved capacities associated with this training plan, including details such\n as instance types, counts, and availability zones.
" + "smithy.api#documentation": "A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
" } } }, "traits": { - "smithy.api#documentation": "Details of the training plan.
\nFor more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using\n Amazon SageMaker Training Plan, see \n CreateTrainingPlan\n .
Details of the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access\n credentials to your private Docker registry.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.
", "smithy.api#required": {} } } @@ -70696,20 +70704,20 @@ "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the training\n algorithm.
", + "smithy.api#documentation": "The Amazon ECR registry path of the Docker image that contains the training algorithm.
", "smithy.api#required": {} } }, "TrainingImageDigest": { "target": "com.amazonaws.sagemaker#ImageDigest", "traits": { - "smithy.api#documentation": "An MD5 hash of the training algorithm that identifies the Docker image used for\n training.
" + "smithy.api#documentation": "An MD5 hash of the training algorithm that identifies the Docker image used for training.
" } }, "SupportedHyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameterSpecifications", "traits": { - "smithy.api#documentation": "A list of the HyperParameterSpecification objects, that define the\n supported hyperparameters. This is required if the algorithm supports automatic model\n tuning.>
A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.
" + "smithy.api#documentation": "Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
" } }, "MetricDefinitions": { "target": "com.amazonaws.sagemaker#MetricDefinitionList", "traits": { - "smithy.api#documentation": "A list of MetricDefinition objects, which are used for parsing metrics\n generated by the algorithm.
A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.
A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.
" + "smithy.api#documentation": "A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
" } }, "AdditionalS3DataSource": { @@ -70833,31 +70841,31 @@ "target": "com.amazonaws.sagemaker#TransformDataSource", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the location of\n the\n channel data, which is, the S3 location of the input data that the\n model can consume.
", + "smithy.api#documentation": "Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.sagemaker#ContentType", "traits": { - "smithy.api#documentation": "The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.
" + "smithy.api#documentation": "The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
" } }, "CompressionType": { "target": "com.amazonaws.sagemaker#CompressionType", "traits": { - "smithy.api#documentation": "If your transform data\n is\n compressed, specify the compression type. Amazon SageMaker automatically\n decompresses the data for the transform job accordingly. The default value is\n None.
If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.
The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:
RecordIO
\nTFRecord
\nWhen splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.
Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.
For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.
For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
Describes the input source of a transform job and the way the transform job consumes\n it.
" + "smithy.api#documentation": "Describes the input source of a transform job and the way the transform job consumes it.
" } }, "com.amazonaws.sagemaker#TransformInstanceCount": { @@ -71502,7 +71510,7 @@ "TransformJobStatus": { "target": "com.amazonaws.sagemaker#TransformJobStatus", "traits": { - "smithy.api#documentation": "The status of the transform job.
\nTransform job statuses are:
\n\n InProgress - The job is in progress.
\n Completed - The job has completed.
\n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.
\n Stopping - The transform job is stopping.
\n Stopped - The transform job has stopped.
The status of the transform job.
Transform job statuses are:
InProgress - The job is in progress.
Completed - The job has completed.
Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
Stopping - The transform job is stopping.
Stopped - The transform job has stopped.
The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.
The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.
The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.
The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.
Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.
" + "smithy.api#documentation": "Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.
" } }, "Environment": { "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" } }, "TransformInput": { @@ -71565,19 +71573,19 @@ "TransformStartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.
Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.
Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the labeling job that created the transform job.
" } }, "AutoMLJobArn": { @@ -71600,7 +71608,7 @@ } }, "traits": { - "smithy.api#documentation": "A batch transform job. For information about SageMaker batch transform, see Use Batch\n Transform.
" + "smithy.api#documentation": "A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.
" } }, "com.amazonaws.sagemaker#TransformJobArn": { @@ -71619,25 +71627,25 @@ "MaxConcurrentTransforms": { "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", "traits": { - "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a\n transform job. The default value is 1.
" + "smithy.api#documentation": "The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
" } }, "MaxPayloadInMB": { "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).
" + "smithy.api#documentation": "The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
" } }, "BatchStrategy": { "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "A string that determines the number of records included in a single mini-batch.
\n\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.
A string that determines the number of records included in a single mini-batch.
SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.
The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" } }, "TransformInput": { @@ -71652,7 +71660,7 @@ "target": "com.amazonaws.sagemaker#TransformOutput", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
", + "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
", "smithy.api#required": {} } }, @@ -71666,7 +71674,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the input needed to run a transform job using the inference specification\n specified in the algorithm.
" + "smithy.api#documentation": "Defines the input needed to run a transform job using the inference specification specified in the algorithm.
" } }, "com.amazonaws.sagemaker#TransformJobName": { @@ -71764,7 +71772,7 @@ "TransformEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Indicates when the transform\n job\n ends on compute instances. For successful jobs and stopped jobs, this\n is the exact time\n recorded\n after the results are uploaded. For failed jobs, this is when Amazon SageMaker\n detected that the job failed.
" + "smithy.api#documentation": "Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.
" } }, "LastModifiedTime": { @@ -71784,12 +71792,12 @@ "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "If the transform job failed,\n the\n reason it failed.
" + "smithy.api#documentation": "If the transform job failed, the reason it failed.
" } } }, "traits": { - "smithy.api#documentation": "Provides a\n summary\n of a transform job. Multiple TransformJobSummary objects are returned as a\n list after in response to a ListTransformJobs call.
Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.
The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http\n call to transfer data from the transform job.
" + "smithy.api#documentation": "The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
" } }, "AssembleWith": { "target": "com.amazonaws.sagemaker#AssemblyType", "traits": { - "smithy.api#documentation": "Defines how to assemble the results of the transform job as a single S3 object. Choose\n a format that is most convenient to you. To concatenate the results in binary format,\n specify None. To add a newline character at the end of every transformed\n record, specify\n Line.
Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n
\nThe KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
" } } }, @@ -71833,7 +71841,7 @@ "target": "com.amazonaws.sagemaker#TransformInstanceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.largeinstance types.
The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
The number of\n ML\n compute instances to use in the transform job. The default value is\n 1, and the maximum is 100. For distributed transform jobs,\n specify a value greater than 1.
The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\n\n The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions.
\nAccelerator: GPU
\nNVIDIA driver version: 470
\nAccelerator: GPU
\nNVIDIA driver version: 535
\nSpecifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions.
Accelerator: GPU
NVIDIA driver version: 470
Accelerator: GPU
NVIDIA driver version: 535
Describes the resources, including ML instance types and ML instance count, to use for\n transform job.
" + "smithy.api#documentation": "Describes the resources, including ML instance types and ML instance count, to use for transform job.
" } }, "com.amazonaws.sagemaker#TransformS3DataSource": { @@ -71869,7 +71877,7 @@ "target": "com.amazonaws.sagemaker#S3DataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.
The following values are compatible: ManifestFile,\n S3Prefix\n
The following value is not compatible: AugmentedManifestFile\n
If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.
If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.
The following values are compatible: ManifestFile, S3Prefix
The following value is not compatible: AugmentedManifestFile
Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:
A key name prefix might look like this:\n\t\ts3://bucketname/exampleprefix/.
A manifest might look like this:\n s3://bucketname/example.manifest\n
The manifest is an S3 object which is a JSON file with the following format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
The preceding JSON matches the following S3Uris:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.
Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix/.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
The preceding JSON matches the following S3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
s3://customer_bucket/some/prefix/relative/path/custdata-N
The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
The list of tags that are associated with the trial. You can use Search\n API to search on the tags.
" + "smithy.api#documentation": "The list of tags that are associated with the trial. You can use Search API to search on the tags.
" } }, "TrialComponentSummaries": { "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", "traits": { - "smithy.api#documentation": "A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.
" + "smithy.api#documentation": "A list of the components associated with the trial. For each component, a summary of the component's properties is included.
" } } }, @@ -71988,7 +71996,7 @@ "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
An array of the parents of the component. A parent is a trial the component is associated\n with and the experiment the trial is part of. A component might not have any parents.
" + "smithy.api#documentation": "An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
" } }, "RunName": { @@ -72098,7 +72106,7 @@ } }, "traits": { - "smithy.api#documentation": "The properties of a trial component as returned by the Search\n API.
" + "smithy.api#documentation": "The properties of a trial component as returned by the Search API.
" } }, "com.amazonaws.sagemaker#TrialComponentArn": { @@ -72117,7 +72125,7 @@ "MediaType": { "target": "com.amazonaws.sagemaker#MediaType", "traits": { - "smithy.api#documentation": "The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.
" + "smithy.api#documentation": "The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
" } }, "Value": { @@ -72130,7 +72138,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an input or output artifact of a trial component. You specify\n TrialComponentArtifact as part of the InputArtifacts and\n OutputArtifacts parameters in the CreateTrialComponent\n request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and\n instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
" + "smithy.api#documentation": "Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
" } }, "com.amazonaws.sagemaker#TrialComponentArtifactValue": { @@ -72262,18 +72270,18 @@ "StringValue": { "target": "com.amazonaws.sagemaker#StringParameterValue", "traits": { - "smithy.api#documentation": "The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.
The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter,\n you can't specify the StringValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
The value of a hyperparameter. Only one of NumberValue or\n StringValue can be specified.
This object is specified in the CreateTrialComponent request.
" + "smithy.api#documentation": "The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
" } }, "com.amazonaws.sagemaker#TrialComponentParameters": { @@ -72425,7 +72433,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed information about the source of a trial component. Either\n ProcessingJob or TrainingJob is returned.
Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.
The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.
The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The status of the component. States include:
\nInProgress
\nCompleted
\nFailed
\nThe status of the component. States include:
InProgress
Completed
Failed
A summary of the properties of a trial component. To get all the properties, call the\n DescribeTrialComponent API and provide the\n TrialComponentName.
A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.
The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.
The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
A summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName.
A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.
\n TtlDuration time unit.
TtlDuration time unit.
\n TtlDuration time value.
TtlDuration time value.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt = EventTime + TtlDuration. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
A flag to stop your hyperparameter tuning job if model performance fails to improve as\n evaluated against an objective function.
" + "smithy.api#documentation": "A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
" } }, "ConvergenceDetected": { "target": "com.amazonaws.sagemaker#ConvergenceDetected", "traits": { - "smithy.api#documentation": "A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has\n detected that your model has converged as evaluated against your objective\n function.
" + "smithy.api#documentation": "A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.
" } } }, @@ -72755,18 +72763,18 @@ "UiTemplateS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket location of the UI template, or worker task template. This is the\n template used to render the worker UI and tools for labeling job tasks. For more\n information about the contents of a UI template, see Creating Your Custom\n Labeling Task Template.
" + "smithy.api#documentation": "The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
" } }, "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.
\nUse this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).
\n Named Entity Recognition\n
\nUse the following HumanTaskUiArn for named entity recognition labeling\n jobs:
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n
\n 3D Point Cloud HumanTaskUiArns\n
\nUse this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n
\n Video Frame HumanTaskUiArns\n
\nUse this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.
\n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n
Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.
\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n
The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.
Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).
Named Entity Recognition
Use the following HumanTaskUiArn for named entity recognition labeling jobs:
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition
3D Point Cloud HumanTaskUiArns
Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation
Video Frame HumanTaskUiArns
Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.
arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection
Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking
Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.
For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.
For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.
Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.
For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.
For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.
Sets whether you can access the domain in Amazon SageMaker Studio:
You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.
You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.
To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
" + } + }, + "DomainAccountId": { + "target": "com.amazonaws.sagemaker#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.
" + } + }, + "DomainRegion": { + "target": "com.amazonaws.sagemaker#RegionName", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.
" + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#UnifiedStudioDomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
" + } + }, + "ProjectId": { + "target": "com.amazonaws.sagemaker#UnifiedStudioProjectId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.sagemaker#UnifiedStudioEnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
" + } + }, + "ProjectS3Path": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" + } + }, "com.amazonaws.sagemaker#UpdateAction": { "type": "operation", "input": { @@ -73072,7 +73148,7 @@ "InstanceGroupsToDelete": { "target": "com.amazonaws.sagemaker#ClusterInstanceGroupsToDelete", "traits": { - "smithy.api#documentation": "Specify the names of the instance groups to delete. \n Use a single , as the separator between multiple names.
Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.
Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.
\nThe UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster\n uptime and availability. Plan accordingly to mitigate potential disruptions to your\n workloads.
Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.
The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.
Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.
", + "smithy.api#documentation": "Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
", "smithy.api#required": {} } }, @@ -73302,7 +73378,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfigForUpdate", "traits": { - "smithy.api#documentation": "The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:
\n {\"username\": UserName, \"password\":\n Password}\n
The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:
{\"username\": UserName, \"password\": Password}
Configuration of the compute allocation definition. This includes the resource sharing\n option, and the setting to preempt low priority tasks.
" + "smithy.api#documentation": "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
" } }, "ComputeQuotaTarget": { @@ -73383,7 +73459,7 @@ "ActivationState": { "target": "com.amazonaws.sagemaker#ActivationState", "traits": { - "smithy.api#documentation": "The state of the compute allocation being described. Use to enable or disable compute\n allocation.
\nDefault is Enabled.
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is Enabled.
Output configuration for storing sample data collected by the fleet.
", + "smithy.api#documentation": "Output configuration for storing sample data collected by the fleet.
", "smithy.api#required": {} } }, "EnableIotRoleAlias": { "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", "traits": { - "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".
\nFor example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".
" + "smithy.api#documentation": "Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".
For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".
" } } }, @@ -73633,7 +73709,7 @@ "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.
The VPC subnets that Studio uses for communication.
\nIf removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.
The VPC subnets that Studio uses for communication.
If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.
Specifies the VPC used for non-EFS traffic.
\n\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.
\n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.
This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.
Specifies the VPC used for non-EFS traffic.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.
VpcOnly - All Studio traffic is through the specified VPC and subnets.
This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Deploys the EndpointConfig specified in the request to a new fleet of\n instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint\n configuration and then deletes the old instances using the previous\n EndpointConfig (there is no availability loss). For more information\n about how to control the update and traffic shifting process, see Update\n models in production.
When SageMaker receives the request, it sets the endpoint status to Updating.\n After updating the endpoint, it sets the status to InService. To check the\n status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.
When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To\n retain the variant properties of an endpoint when updating it, set\n RetainAllVariantProperties to true. To use the variant\n properties specified in a new EndpointConfig call when updating an\n endpoint, set RetainAllVariantProperties to false. The default\n is false.
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.
When you are updating endpoint resources with RetainAllVariantProperties,\n whose value is set to true, ExcludeRetainedVariantProperties\n specifies the list of type VariantProperty\n to override with the values provided by EndpointConfig. If you don't\n specify a value for ExcludeRetainedVariantProperties, no variant properties\n are overridden.
When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.
The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" + "smithy.api#documentation": "The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
" } }, "RetainDeploymentConfig": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).
" + "smithy.api#documentation": "Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
" } } }, @@ -73774,7 +73850,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
Adds, updates, or removes the description of an experiment. Updates the display name of an\n experiment.
" + "smithy.api#documentation": "Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
" } }, "com.amazonaws.sagemaker#UpdateExperimentRequest": { @@ -73851,7 +73927,7 @@ "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.
The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.
Updates the feature group by either adding features or updating the online store\n configuration. Use one of the following request parameters at a time while using the\n UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions\n request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the\n OnlineStoreConfig request parameter. If a TtlDuration is\n specified, the default TtlDuration applies for all records added to the\n feature group after the feature group is updated. If a record level\n TtlDuration exists from using the PutRecord API, the record\n level TtlDuration applies to that record instead of the default\n TtlDuration. To remove the default TtlDuration from an\n existing feature group, use the UpdateFeatureGroup API and set the\n TtlDuration\n Unit and Value to null.
Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.
You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.
You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.
Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.
" + "smithy.api#documentation": "Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.
" } }, "OnlineStoreConfig": { @@ -73970,7 +74046,7 @@ "target": "com.amazonaws.sagemaker#FeatureGroupNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that\n you're updating.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.
", "smithy.api#required": {} } }, @@ -73997,7 +74073,7 @@ "ParameterRemovals": { "target": "com.amazonaws.sagemaker#FeatureParameterRemovals", "traits": { - "smithy.api#documentation": "A list of parameter keys that you can specify to remove parameters that describe your\n feature.
" + "smithy.api#documentation": "A list of parameter keys that you can specify to remove parameters that describe your feature.
" } } }, @@ -74039,7 +74115,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates SageMaker hub content (either a Model or Notebook\n resource).
You can update the metadata that describes the resource. In addition to the required request\n fields, specify at least one of the following fields to update:
\n\n HubContentDescription\n
\n HubContentDisplayName\n
\n HubContentMarkdown\n
\n HubContentSearchKeywords\n
\n SupportStatus\n
For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.
\nIf you want to update a ModelReference resource in your hub, use the\n UpdateHubContentResource API instead.
Updates SageMaker hub content (either a Model or Notebook resource).
You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:
HubContentDescription
HubContentDisplayName
HubContentMarkdown
HubContentSearchKeywords
SupportStatus
For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.
If you want to update a ModelReference resource in your hub, use the UpdateHubContentResource API instead.
Updates the contents of a SageMaker hub for a ModelReference resource.\n A ModelReference allows you to access public SageMaker JumpStart\n models from within your private hub.
When using this API, you can update the\n MinVersion field for additional flexibility in the model version. You shouldn't update\n any additional fields when using this API, because the metadata in your private hub\n should match the public JumpStart model's metadata.
If you want to update a Model or Notebook\n resource in your hub, use the UpdateHubContent API instead.
For more information about adding model references to your hub, see\n \n Add models to a private hub.
" + "smithy.api#documentation": "Updates the contents of a SageMaker hub for a ModelReference resource. A ModelReference allows you to access public SageMaker JumpStart models from within your private hub.
When using this API, you can update the MinVersion field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata.
If you want to update a Model or Notebook resource in your hub, use the UpdateHubContent API instead.
For more information about adding model references to your hub, see Add models to a private hub.
" } }, "com.amazonaws.sagemaker#UpdateHubContentReferenceRequest": { @@ -74085,14 +74161,14 @@ "target": "com.amazonaws.sagemaker#HubContentType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The content type of the resource that you want to update. Only specify a\n ModelReference resource for this API. To update a Model\n or Notebook resource, use the UpdateHubContent API instead.
The content type of the resource that you want to update. Only specify a ModelReference resource for this API. To update a Model or Notebook resource, use the UpdateHubContent API instead.
The minimum hub content version of the referenced model that you want to use.\n The minimum version must be older than the latest available version of the referenced model.\n To support all versions of a model, set the value to 1.0.0.
The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to 1.0.0.
The name of the SageMaker hub that contains the hub content you want to update.\n You can optionally use the hub ARN instead.
", + "smithy.api#documentation": "The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.
", "smithy.api#required": {} } }, @@ -74147,7 +74223,7 @@ "target": "com.amazonaws.sagemaker#HubContentType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The content type of the resource that you want to update. Only specify a\n Model or Notebook resource for this API. To\n update a ModelReference, use the\n UpdateHubContentReference API instead.
The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.
The hub content version that you want to update. For example, if you have\n two versions of a resource in your hub, you can update the second version.
", + "smithy.api#documentation": "The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.
", "smithy.api#required": {} } }, @@ -74285,7 +74361,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the properties of a SageMaker AI image. To change the image's tags, use the\n AddTags and DeleteTags APIs.
" + "smithy.api#documentation": "Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.
" } }, "com.amazonaws.sagemaker#UpdateImageRequest": { @@ -74294,7 +74370,7 @@ "DeleteProperties": { "target": "com.amazonaws.sagemaker#ImageDeletePropertyList", "traits": { - "smithy.api#documentation": "A list of properties to delete. Only the Description and\n DisplayName properties can be deleted.
A list of properties to delete. Only the Description and DisplayName properties can be deleted.
The availability of the image version specified by the maintainer.
\n\n NOT_PROVIDED: The maintainers did not provide a status for image version stability.
\n STABLE: The image version is stable.
\n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
\n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
The availability of the image version specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable.
TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
Indicates SageMaker AI job type compatibility.
\n\n TRAINING: The image version is compatible with SageMaker AI training jobs.
\n INFERENCE: The image version is compatible with SageMaker AI inference jobs.
\n NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates SageMaker AI job type compatibility.
TRAINING: The image version is compatible with SageMaker AI training jobs.
INFERENCE: The image version is compatible with SageMaker AI inference jobs.
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Indicates CPU or GPU compatibility.
\n\n CPU: The image version is compatible with CPU.
\n GPU: The image version is compatible with GPU.
Indicates CPU or GPU compatibility.
CPU: The image version is compatible with CPU.
GPU: The image version is compatible with GPU.
Details about the resources to deploy with this inference component, including the\n model, container, and compute resources.
" + "smithy.api#documentation": "Details about the resources to deploy with this inference component, including the model, container, and compute resources.
" } }, "RuntimeConfig": { @@ -74501,7 +74577,7 @@ "DeploymentConfig": { "target": "com.amazonaws.sagemaker#InferenceComponentDeploymentConfig", "traits": { - "smithy.api#documentation": "The deployment configuration for the inference component. The configuration contains the\n desired deployment strategy and rollback settings.
" + "smithy.api#documentation": "The deployment configuration for the inference component. The configuration contains the desired deployment strategy and rollback settings.
" } } }, @@ -74599,7 +74675,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates an inference experiment that you created. The status of the inference experiment has to be either\n Created, Running. For more information on the status of an inference experiment,\n see DescribeInferenceExperiment.\n
Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.
\n The duration for which the inference experiment will run. If the status of the inference experiment is\n Created, then you can update both the start and end dates. If the status of the inference\n experiment is Running, then you can update only the end date.\n
The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.
\n An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n
An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.
\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n
The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.
The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow\n Tracking Server.
" + "smithy.api#documentation": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.
" } }, "TrackingServerSize": { @@ -74713,13 +74789,13 @@ "AutomaticModelRegistration": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. \n To enable automatic model registration, set this value to True. \n To disable automatic model registration, set this value to False. \n If not specified, AutomaticModelRegistration defaults to False\n
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False
The new weekly maintenance window start day and time to update. The maintenance window day and time should be \n in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" + "smithy.api#documentation": "The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
" } } }, @@ -74761,7 +74837,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an Amazon SageMaker Model Card.
\nYou cannot update both model card content and model card status in a single call.
\nUpdate an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
The updated model card content. Content must be in model card JSON schema and provided as a string.
\nWhen updating model card content, be sure to include the full content and not just updated content.
" + "smithy.api#documentation": "The updated model card content. Content must be in model card JSON schema and provided as a string.
When updating model card content, be sure to include the full content and not just updated content.
" } }, "ModelCardStatus": { "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates should be made to the model\n card, but it can still be exported.
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
An array of additional Inference Specification objects to be added to the \n existing array additional Inference Specification. Total number of additional \n Inference Specifications can not exceed 15. Each additional Inference Specification \n specifies artifacts based on this model package that can be used on inference endpoints. \n Generally used with SageMaker Neo to store the compiled artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" } }, "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this\n model package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies details about inference jobs that you can run with models based on this model package, including the following information:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
Within EvaluationPeriod, how many execution failures will raise an\n alert.
Within EvaluationPeriod, how many execution failures will raise an alert.
The number of most recent monitoring executions to consider when evaluating alert\n status.
", + "smithy.api#documentation": "The number of most recent monitoring executions to consider when evaluating alert status.
", "smithy.api#required": {} } } @@ -75026,7 +75102,7 @@ "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services \n Region within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -75034,7 +75110,7 @@ "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring \n job.
", + "smithy.api#documentation": "The configuration object that specifies the monitoring schedule and defines the monitoring job.
", "smithy.api#required": {} } } @@ -75073,7 +75149,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a notebook instance. NotebookInstance updates include upgrading or\n downgrading the ML compute instance used for your notebook instance to accommodate\n changes in your workload requirements.
" + "smithy.api#documentation": "Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.
" } }, "com.amazonaws.sagemaker#UpdateNotebookInstanceInput": { @@ -75096,67 +75172,67 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to\n access the notebook instance. For more information, see SageMaker AI Roles.
\nTo be able to pass this role to SageMaker AI, the caller of this API must\n have the iam:PassRole permission.
The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.
" + "smithy.api#documentation": "The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
" } }, "DisassociateLifecycleConfig": { "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceLifecycleConfig", "traits": { - "smithy.api#documentation": "Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.
Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't\n determine the amount of available free space on the volume. Because of this, you can\n increase the volume size when you update a notebook instance, but you can't decrease the\n volume size. If you want to decrease the size of the ML storage volume in use, create a\n new notebook instance with the desired size.
" + "smithy.api#documentation": "The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.
" } }, "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit\n or in any other Git repository. When you open a notebook instance, it opens in the\n directory that contains this repository. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit\n or in any other Git repository. These repositories are cloned at the same level as the\n default repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker AI Notebook Instances.
" + "smithy.api#documentation": "An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.
" } }, "AcceleratorTypes": { "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to associate with\n this notebook instance.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to associate with this notebook instance.
" } }, "DisassociateAcceleratorTypes": { "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer\n available.
\nThis parameter was used to specify a list of the EI instance types to remove from this notebook\n instance.
" + "smithy.api#documentation": "This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
" } }, "DisassociateDefaultCodeRepository": { "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", "traits": { - "smithy.api#documentation": "The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.
" + "smithy.api#documentation": "The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
" } }, "DisassociateAdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", "traits": { - "smithy.api#documentation": "A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.
" + "smithy.api#documentation": "A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
" } }, "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.
If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.
Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.
If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.
The shell script that runs only once, when you create a notebook instance. The shell\n script must be a base64-encoded string.
" + "smithy.api#documentation": "The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
" } }, "OnStart": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { - "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance. The shell script must be a base64-encoded\n string.
" + "smithy.api#documentation": "The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
" } } }, @@ -75246,7 +75322,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates all of the SageMaker Partner AI Apps in an account.
" + "smithy.api#documentation": "Updates all of the SageMaker Partner AI Apps in an account.
" } }, "com.amazonaws.sagemaker#UpdatePartnerAppRequest": { @@ -75294,7 +75370,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" } } }, @@ -75382,7 +75458,7 @@ "ParallelismConfiguration": { "target": "com.amazonaws.sagemaker#ParallelismConfiguration", "traits": { - "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
" } } }, @@ -75430,7 +75506,7 @@ "PipelineDefinitionS3Location": { "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", "traits": { - "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
" } }, "PipelineDescription": { @@ -75484,7 +75560,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.
\nYou must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.
Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.
You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.
The product ID and provisioning artifact ID to provision a service catalog. \n The provisioning artifact ID will default to the latest provisioning artifact \n ID of the product, if you don't provide the provisioning artifact ID. For more \n information, see What is Amazon Web Services Service Catalog.\n
" + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your \n Amazon Web Services resources in different ways, for example, by purpose, owner, or \n environment. For more information, see Tagging Amazon Web Services Resources.\n In addition, the project must have tag update constraints set in order to include this \n parameter in the request. For more information, see Amazon Web Services Service \n Catalog Tag Update Constraints.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.
" } } }, @@ -75557,7 +75633,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the settings of a space.
\nYou can't edit the app type of a space in the SpaceSettings.
Updates the settings of a space.
You can't edit the app type of a space in the SpaceSettings.
Update a model training job to request a new Debugger profiling configuration or to\n change warm pool retention length.
" + "smithy.api#documentation": "Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
" } }, "com.amazonaws.sagemaker#UpdateTrainingJobRequest": { @@ -75644,25 +75720,25 @@ "ProfilerConfig": { "target": "com.amazonaws.sagemaker#ProfilerConfigForUpdate", "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and\n storage paths.
" + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
" } }, "ProfilerRuleConfigurations": { "target": "com.amazonaws.sagemaker#ProfilerRuleConfigurations", "traits": { - "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework\n metrics.
" + "smithy.api#documentation": "Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
" } }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfigForUpdate", "traits": { - "smithy.api#documentation": "The training job ResourceConfig to update warm pool retention\n length.
The training job ResourceConfig to update warm pool retention length.
Configuration for remote debugging while the training job is running. You can update\n the remote debugging configuration when the SecondaryStatus of the job is\n Downloading or Training.To learn more about the remote\n debugging functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.
The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.
The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
\nThe worker portal is now supported in VPC and public internet.
\n Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.
To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
\nUse OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
\nAfter restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the DescribeWorkforce\n operation.
\nThis operation only applies to private workforces.
\nUse this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
The worker portal is now supported in VPC and public internet.
Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.
To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".
Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.
Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.
After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.
This operation only applies to private workforces.
The name of the private workforce that you want to update. You can find your workforce\n name by using the ListWorkforces operation.
", + "smithy.api#documentation": "The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
", "smithy.api#required": {} } }, "SourceIpConfig": { "target": "com.amazonaws.sagemaker#SourceIpConfig", "traits": { - "smithy.api#documentation": "A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.
\nMaximum: Ten CIDR values
" + "smithy.api#documentation": "A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
" } }, "OidcConfig": { "target": "com.amazonaws.sagemaker#OidcConfig", "traits": { - "smithy.api#documentation": "Use this parameter to update your OIDC Identity Provider (IdP) \n configuration for a workforce made using your own IdP.
" + "smithy.api#documentation": "Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
" } }, "WorkforceVpcConfig": { @@ -75977,7 +76053,7 @@ "target": "com.amazonaws.sagemaker#Workforce", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", + "smithy.api#documentation": "A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
", "smithy.api#required": {} } } @@ -76017,7 +76093,7 @@ "MemberDefinitions": { "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.
A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
The IAM Identity details associated with the user. These details are\n associated with model package groups, model packages, and project entities only.
" + "smithy.api#documentation": "The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
" } } }, "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, project, or model card.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
" } }, "com.amazonaws.sagemaker#UserProfileArn": { @@ -76235,13 +76311,13 @@ "ExecutionRole": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "The execution role for the user.
\nSageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" + "smithy.api#documentation": "The execution role for the user.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" } }, "SecurityGroups": { "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\n communication.
\nOptional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for\n the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the\n maximum number shown.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "SharingSettings": { @@ -76271,7 +76347,7 @@ "RStudioServerProAppSettings": { "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", "traits": { - "smithy.api#documentation": "A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure user interaction with the RStudioServerPro app.
The Canvas app settings.
\nSageMaker applies these settings only to private spaces that SageMaker creates for the Canvas\n app.
" + "smithy.api#documentation": "The Canvas app settings.
SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
" } }, "CodeEditorAppSettings": { "target": "com.amazonaws.sagemaker#CodeEditorAppSettings", "traits": { - "smithy.api#documentation": "The Code Editor application settings.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "The Code Editor application settings.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "JupyterLabAppSettings": { "target": "com.amazonaws.sagemaker#JupyterLabAppSettings", "traits": { - "smithy.api#documentation": "The settings for the JupyterLab application.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "The settings for the JupyterLab application.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "SpaceStorageSettings": { "target": "com.amazonaws.sagemaker#DefaultSpaceStorageSettings", "traits": { - "smithy.api#documentation": "The storage settings for a space.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "The storage settings for a space.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "DefaultLandingUri": { "target": "com.amazonaws.sagemaker#LandingUri", "traits": { - "smithy.api#documentation": "The default experience that the user is directed to when accessing the domain. The\n supported values are:
\n\n studio::: Indicates that Studio is the default experience. This value can\n only be passed if StudioWebPortal is set to ENABLED.
\n app:JupyterServer:: Indicates that Studio Classic is the default\n experience.
The default experience that the user is directed to when accessing the domain. The supported values are:
studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.
app:JupyterServer:: Indicates that Studio Classic is the default experience.
Whether the user can access Studio. If this value is set to DISABLED, the\n user cannot access Studio, even if that is the default experience for the domain.
Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.
Details about the POSIX identity that is used for file system operations.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "Details about the POSIX identity that is used for file system operations.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "CustomFileSystemConfigs": { "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a user profile. Permitted users can\n access this file system in Amazon SageMaker AI Studio.
\nSageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" + "smithy.api#documentation": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
" } }, "StudioWebPortalSettings": { "target": "com.amazonaws.sagemaker#StudioWebPortalSettings", "traits": { - "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" } }, "AutoMountHomeEFS": { "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", "traits": { - "smithy.api#documentation": "Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" + "smithy.api#documentation": "Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" } } }, "traits": { - "smithy.api#documentation": "A collection of settings that apply to users in a domain. These settings are specified\n when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
The type of variant property. The supported values are:
\n\n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values in the\n ProductionVariants of CreateEndpointConfig.
\n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the\n ProductionVariants of CreateEndpointConfig.
\n DataCaptureConfig: (Not currently supported.)
The type of variant property. The supported values are:
DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.
DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
DataCaptureConfig: (Not currently supported.)
Specifies a production variant property type for an Endpoint.
\nIf you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to true, the\n VariantProperty objects listed in the\n ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the\n endpoint.
Specifies a production variant property type for an Endpoint.
If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.
The type of the lineage entity resource. For example: DataSet, Model, Endpoint, \n etc...
The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...
The key that specifies the tag that you're using to filter the search results. It must be\n in the following format: Tags..
The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags.<key>.
The list of key-value pairs used to filter your search results. If a search result\n contains a key from your list, it is included in the final search response if the value\n associated with the key in the result matches the value you specified. If the value doesn't\n match, the result is excluded from the search response. Any resources that don't have a key\n from the list that you've provided will also be included in the search response.
" + "smithy.api#documentation": "The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.
" } }, "com.amazonaws.sagemaker#VisibilityConditionsKey": { @@ -76669,7 +76745,7 @@ "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.
", + "smithy.api#documentation": "The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources\n have access to. You can control access to and from your resources by configuring a VPC.\n For more information, see Give SageMaker Access to\n Resources in your Amazon VPC.
" + "smithy.api#documentation": "Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
" } }, "com.amazonaws.sagemaker#VpcId": { @@ -76774,14 +76850,14 @@ "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the warm pool.
\n\n InUse: The warm pool is in use for the training job.
\n Available: The warm pool is available to reuse for a matching\n training job.
\n Reused: The warm pool moved to a matching training job for\n reuse.
\n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.
The status of the warm pool.
InUse: The warm pool is in use for the training job.
Available: The warm pool is available to reuse for a matching training job.
Reused: The warm pool moved to a matching training job for reuse.
Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.
The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.
\nMultiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.
The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.
Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.
The most recent date that UpdateWorkforce was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.
" + "smithy.api#documentation": "The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
" } }, "SourceIpConfig": { "target": "com.amazonaws.sagemaker#SourceIpConfig", "traits": { - "smithy.api#documentation": "A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
" + "smithy.api#documentation": "A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
" } }, "SubDomain": { @@ -76869,7 +76945,7 @@ "CognitoConfig": { "target": "com.amazonaws.sagemaker#CognitoConfig", "traits": { - "smithy.api#documentation": "The configuration of an Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.
" + "smithy.api#documentation": "The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
" } }, "OidcConfig": { @@ -76904,7 +76980,7 @@ } }, "traits": { - "smithy.api#documentation": "A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
" + "smithy.api#documentation": "A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
" } }, "com.amazonaws.sagemaker#WorkforceArn": { @@ -77112,7 +77188,7 @@ "S3ArtifactPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts\n existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users\n must log out and log back in to apply the new location.
" + "smithy.api#documentation": "The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.
" } }, "S3KmsKeyId": { @@ -77141,7 +77217,7 @@ "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.
A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.
The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.
" + "smithy.api#documentation": "The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
" } }, "CreateDate": { @@ -77194,7 +77270,7 @@ "NotificationConfiguration": { "target": "com.amazonaws.sagemaker#NotificationConfiguration", "traits": { - "smithy.api#documentation": "Configures SNS notifications of available or expiring work items for work\n teams.
" + "smithy.api#documentation": "Configures SNS notifications of available or expiring work items for work teams.
" } }, "WorkerAccessConfiguration": { diff --git a/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json b/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json index f6d6de10..1b278998 100644 --- a/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json +++ b/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json @@ -3410,6 +3410,9 @@ "target": "com.amazonaws.servicecatalog#DeleteServiceActionOutput" }, "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" + }, { "target": "com.amazonaws.servicecatalog#ResourceInUseException" }, @@ -4949,6 +4952,9 @@ "target": "com.amazonaws.servicecatalog#DisassociateServiceActionFromProvisioningArtifactOutput" }, "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" + }, { "target": "com.amazonaws.servicecatalog#ResourceNotFoundException" } diff --git a/models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json b/models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json index 0b2c791b..5ab52727 100644 --- a/models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json +++ b/models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json @@ -150,6 +150,66 @@ "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,128}$" } }, + "com.amazonaws.servicequotas#CreateSupportCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicequotas#CreateSupportCaseRequest" + }, + "output": { + "target": "com.amazonaws.servicequotas#CreateSupportCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicequotas#AccessDeniedException" + }, + { + "target": "com.amazonaws.servicequotas#DependencyAccessDeniedException" + }, + { + "target": "com.amazonaws.servicequotas#IllegalArgumentException" + }, + { + "target": "com.amazonaws.servicequotas#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.servicequotas#NoSuchResourceException" + }, + { + "target": "com.amazonaws.servicequotas#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.servicequotas#ServiceException" + }, + { + "target": "com.amazonaws.servicequotas#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Support case for an existing quota increase request. This call only creates \n a Support case if the request has a Pending status.
The ID of the pending quota increase request for which you want to open a Support case.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.servicequotas#CreateSupportCaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.servicequotas#CustomerServiceEngagementId": { "type": "string" }, @@ -2300,6 +2360,9 @@ { "target": "com.amazonaws.servicequotas#AssociateServiceQuotaTemplate" }, + { + "target": "com.amazonaws.servicequotas#CreateSupportCase" + }, { "target": "com.amazonaws.servicequotas#DeleteServiceQuotaIncreaseRequestFromTemplate" }, diff --git a/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json b/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json index 2d1ad585..655099e6 100644 --- a/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json +++ b/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json @@ -507,6 +507,16 @@ } } }, + "com.amazonaws.ssoadmin#ApplicationNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, "com.amazonaws.ssoadmin#ApplicationProvider": { "type": "structure", "members": { @@ -537,7 +547,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
" + "smithy.api#documentation": "A structure that describes a provider that can be used to connect an Amazon Web Services managed\n application or customer managed application to IAM Identity Center.
" } }, "com.amazonaws.ssoadmin#ApplicationProviderArn": { @@ -768,7 +778,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that stores the details of the Amazon Web Services managed policy.
" + "smithy.api#documentation": "A structure that stores a list of managed policy ARNs that describe the associated Amazon Web Services managed policy.
" } }, "com.amazonaws.ssoadmin#AttachedManagedPolicyList": { @@ -834,12 +844,12 @@ "RedirectUris": { "target": "com.amazonaws.ssoadmin#RedirectUris", "traits": { - "smithy.api#documentation": "A list of URIs that are valid locations to redirect a user's browser after the user is authorized.
" + "smithy.api#documentation": "A list of URIs that are valid locations to redirect a user's browser after the user is\n authorized.
\nRedirectUris is required when the grant type is\n authorization_code.
A structure that defines configuration settings for an application that supports the OAuth 2.0 Authorization Code Grant.
" + "smithy.api#documentation": "A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Authorization Code Grant.
" } }, "com.amazonaws.ssoadmin#AuthorizedTokenIssuer": { @@ -1041,7 +1051,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an application in IAM Identity Center for the given application provider.
" + "smithy.api#documentation": "Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given\n application provider.
\nThis API does not support creating SAML 2.0 customer managed applications or Amazon Web Services\n managed applications. To learn how to create an Amazon Web Services managed application, see the\n application user guide. You can create a SAML 2.0 customer managed application in\n the Amazon Web Services Management Console only. See Setting\n up customer managed SAML 2.0 applications. For more information on these\n application types, see Amazon Web Services managed\n applications.
\nThe ARN of the application provider under which the operation will run.
", + "smithy.api#documentation": "The ARN of the application for which the assignment is created.
", "smithy.api#required": {} } }, "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", "smithy.api#required": {} } }, @@ -1121,7 +1131,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -1133,7 +1143,7 @@ } }, "Name": { - "target": "com.amazonaws.ssoadmin#NameType", + "target": "com.amazonaws.ssoadmin#ApplicationNameType", "traits": { "smithy.api#documentation": "The name of the .
", "smithy.api#required": {} @@ -1218,7 +1228,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not\n managed by Organizations or a member Amazon Web Services account in an organization. You can\n create only one instance per account and across all Amazon Web Services Regions.
\nThe CreateInstance request is rejected if the following apply:
\nThe instance is created within the organization management account.
\nAn instance already exists in the same account.
\nCreates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not\n managed by Organizations or a member Amazon Web Services account in an organization. You can create only\n one instance per account and across all Amazon Web Services Regions.
\nThe CreateInstance request is rejected if the following apply:
\nThe instance is created within the organization management account.
\nAn instance already exists in the same account.
\nCreates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.
\nThis trusted token issuer describes an external identity\n provider (IdP) that can generate claims or assertions in the form of access tokens for a\n user. Applications enabled for IAM Identity Center can use these tokens for authentication.
" + "smithy.api#documentation": "Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted\n identity propagation to be used with applications that authenticate outside of\n Amazon Web Services.
\nThis trusted token issuer describes an external identity provider (IdP) that can generate claims or\n assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center\n can use these tokens for authentication.
" } }, "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerRequest": { @@ -1772,7 +1782,7 @@ "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", "smithy.api#required": {} } }, @@ -2244,7 +2254,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
\nDeleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.
\nDeletes a trusted token issuer configuration from an instance of IAM Identity Center.
\nDeleting this trusted token issuer configuration will cause users to lose access to any\n applications that are configured to use the trusted token issuer.
\nRetrieves a direct assignment of a user or group to an application. If the user doesn\u2019t have a direct assignment to the application, \n the user may still have access to the application through a group. Therefore, don\u2019t use this API to test access to an application for a user. \n Instead use ListApplicationAssignmentsForPrincipal.
" + "smithy.api#documentation": "Retrieves a direct assignment of a user or group to an application. If the user\n doesn\u2019t have a direct assignment to the application, the user may still have access to\n the application through a group. Therefore, don\u2019t use this API to test access to an\n application for a user. Instead use ListApplicationAssignmentsForPrincipal.
" } }, "com.amazonaws.ssoadmin#DescribeApplicationAssignmentRequest": { @@ -2463,14 +2473,14 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "Specifies the ARN of the application.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", "smithy.api#required": {} } }, @@ -2498,7 +2508,7 @@ "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "smithy.api#documentation": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" } }, "ApplicationArn": { @@ -2538,7 +2548,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
" + "smithy.api#documentation": "Retrieves details about a provider that can be used to connect an Amazon Web Services managed\n application or customer managed application to IAM Identity Center.
" } }, "com.amazonaws.ssoadmin#DescribeApplicationProviderRequest": { @@ -2689,7 +2699,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the details of an instance of IAM Identity Center. The status can be one of the following:
\n\n CREATE_IN_PROGRESS - The instance is in the process of being created. When the\n instance is ready for use, DescribeInstance returns the status of\n ACTIVE. While the instance is in the\n CREATE_IN_PROGRESS state, you can call only DescribeInstance\n and DeleteInstance operations.
\n DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes.
\n ACTIVE - The instance is active.
Returns the details of an instance of IAM Identity Center. The status can be one of the\n following:
\n\n CREATE_IN_PROGRESS - The instance is in the process of being\n created. When the instance is ready for use, DescribeInstance returns the status\n of ACTIVE. While the instance is in the\n CREATE_IN_PROGRESS state, you can call only DescribeInstance\n and DeleteInstance operations.
\n DELETE_IN_PROGRESS - The instance is being deleted. Returns\n AccessDeniedException after the delete operation completes.\n
\n ACTIVE - The instance is active.
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.\n
" + "smithy.api#documentation": "Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details\n include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and\n the destination attribute for a trusted token issuer configuration.
" } }, "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerRequest": { @@ -3350,7 +3360,7 @@ "target": "com.amazonaws.ssoadmin#AssignmentRequired", "traits": { "smithy.api#default": true, - "smithy.api#documentation": "If AssignmentsRequired is true (default value), users don\u2019t have access to the application unless an assignment is created using the \n CreateApplicationAssignment API. If false, all users have access to the application.
If AssignmentsRequired is true (default value), users don\u2019t\n have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application.
Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.
Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer\n grant type.
Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.
Configuration options for the\n urn:ietf:params:oauth:grant-type:token-exchange grant type.
The Grant union represents the set of possible configuration options for the selected grant type. Exactly one member of the union must be specified, and must match the grant type selected.
" + "smithy.api#documentation": "The Grant union represents the set of possible configuration options for the selected\n grant type. Exactly one member of the union must be specified, and must match the grant\n type selected.
" } }, "com.amazonaws.ssoadmin#GrantItem": { @@ -3919,12 +3929,12 @@ "AuthorizedTokenIssuers": { "target": "com.amazonaws.ssoadmin#AuthorizedTokenIssuers", "traits": { - "smithy.api#documentation": "A list of allowed token issuers trusted by the Identity Center instances for this application.
" + "smithy.api#documentation": "A list of allowed token issuers trusted by the Identity Center instances for this\n application.
\n\n AuthorizedTokenIssuers is required when the grant type is\n JwtBearerGrant.
A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant.
" + "smithy.api#documentation": "A structure that defines configuration settings for an application that supports the\n JWT Bearer Token Authorization Grant. The AuthorizedAudience field is the\n aud claim. For more information, see RFC 7523.
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access\n to.
", + "smithy.api#documentation": "Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access\n to. This action must be called from the management account containing your organization\n instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4576,7 +4586,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the applications to which a specified principal is assigned.
", + "smithy.api#documentation": "Lists the applications to which a specified principal is assigned. You must provide a\n filter when calling this action from a member account against your organization instance\n of IAM Identity Center. A filter is not required when called from the management account against an\n organization instance of IAM Identity Center, or from a member account against an account instance of\n IAM Identity Center in the same account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4949,7 +4959,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance\n in the management account, member accounts must use the applicationAccount\n parameter to filter the list to only applications created from that account.
Lists all applications associated with the instance of IAM Identity Center. When listing\n applications for an organization instance in the management account, member accounts\n must use the applicationAccount parameter to filter the list to only\n applications created from that account. When listing applications for an account\n instance in the same member account, a filter is not required.
The ARN of the IAM Identity Center application under which the operation will run.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, @@ -5713,7 +5723,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy/[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]+$" + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy((/[A-Za-z0-9\\.,\\+@=_-]+)*)/([A-Za-z0-9\\.,\\+=@_-]+)$" } }, "com.amazonaws.ssoadmin#ManagedPolicyName": { @@ -5770,21 +5780,21 @@ "IssuerUrl": { "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerUrl", "traits": { - "smithy.api#documentation": "The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.
", + "smithy.api#documentation": "The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain\n the information required to verify the tokens that the trusted token issuer generates.
", "smithy.api#required": {} } }, "ClaimAttributePath": { "target": "com.amazonaws.ssoadmin#ClaimAttributePath", "traits": { - "smithy.api#documentation": "The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for\n an IAM Identity Center token.
The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n IdentityStoreAttributePath when a trusted token issuer token is exchanged for an\n IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for\n an IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center\n token.
The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for\n an IAM Identity Center token.
The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n IdentityStoreAttributePath when a trusted token issuer token is exchanged for an\n IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for\n an IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center\n token.
Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don\u2019t have access to the application unless an assignment is created using the \n CreateApplicationAssignment API. If false, all users have access to the application. \n If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.
Configure how users gain access to an application. If AssignmentsRequired\n is true (default value), users don\u2019t have access to the application unless\n an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if\n AssignmentsRequired is set to true.
If AssignmentsRequired is true (default value), users don\u2019t have access to the application unless an assignment is created using the \n CreateApplicationAssignment API. If false, all users have access to the application.
If AssignmentsRequired is true (default value), users don\u2019t\n have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application.
Adds a grant to an application.
", + "smithy.api#documentation": "Creates a configuration for an application to use grants. Conceptually grants are\n authorization to request actions related to tokens. This configuration will be used when\n parties are requesting and receiving tokens during the trusted identity propagation\n process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0\n and OAuth 2.0.
\nA grant is created between your applications and Identity Center instance which\n enables an application to use specified mechanisms to obtain tokens. These tokens are\n used by your applications to gain access to Amazon Web Services resources on behalf of users. The\n following elements are within these exchanges:
\n\n Requester - The application requesting access\n to Amazon Web Services resources.
\n\n Subject - Typically the user that is\n requesting access to Amazon Web Services resources.
\n\n Grant - Conceptually, a grant is\n authorization to access Amazon Web Services resources. These grants authorize token generation\n for authenticating access to the requester and for the request to make requests\n on behalf of the subjects. There are four types of grants:
\n\n AuthorizationCode - Allows an\n application to request authorization through a series of user-agent\n redirects.
\n\n JWT bearer - Authorizes an\n application to exchange a JSON Web Token that came from an external\n identity provider. To learn more, see RFC\n 6479.
\n\n Refresh token - Enables application\n to request new access tokens to replace expiring or expired access\n tokens.
\n\n Exchange token - A grant that\n requests tokens from the authorization server by providing a \u2018subject\u2019\n token with access scope authorizing trusted identity propagation to this\n application. To learn more, see RFC\n 8693.
\n\n Authorization server - IAM Identity Center requests\n tokens.
\nUser credentials are never shared directly within these exchanges. Instead,\n applications use grants to request access tokens from IAM Identity Center. For more\n information, see RFC\n 6479.
\n\n Use cases\n
\nConnecting to custom applications.
\nConfiguring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT\n tokens.
\nA structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant.
" + "smithy.api#documentation": "A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Refresh Token Grant. For more, see RFC\n 6749.
" } }, "com.amazonaws.ssoadmin#RelayState": { @@ -6891,7 +6901,7 @@ "name": "sso" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage\n their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended\n approach for workforce authentication and authorization in Amazon Web Services, for organizations of\n any size and type.
\nIAM Identity Center uses the sso and identitystore API\n namespaces.
This reference guide provides information on single sign-on operations which could be\n used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see\n the IAM Identity Center\n User Guide.
\nMany operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as\n principals. For more information about how to work with principals and principal IDs in\n IAM Identity Center, see the Identity Store API\n Reference.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The\n SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.
\nIAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed\n applications and other Amazon Web Services resources. You can connect your existing identity provider\n and synchronize users and groups from your directory, or create and manage your users\n directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
\nUser access to applications
\nUser access to Amazon Web Services accounts
\nThis guide provides information about single sign-on operations that you can use for access to applications and \n Amazon Web Services accounts. For information about IAM Identity Center features, see the\n IAM Identity Center\n User Guide.
\nIAM Identity Center uses the sso and identitystore API\n namespaces.
Many API operations for IAM Identity Center rely on identifiers for users and groups, known as\n principals. For more information about how to work with principals and principal IDs in\n IAM Identity Center, see the Identity Store API\n Reference.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The\n SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.
\nA structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant.
" + "smithy.api#documentation": "A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Token Exchange Grant. For more information, see RFC 8693.
" } }, "com.amazonaws.ssoadmin#TokenIssuerAudience": { @@ -8391,7 +8401,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that describes the options for the access portal associated with an application that can be updated.
" + "smithy.api#documentation": "A structure that describes the options for the access portal associated with an\n application that can be updated.
" } }, "com.amazonaws.ssoadmin#UpdateApplicationRequest": { @@ -8405,7 +8415,7 @@ } }, "Name": { - "target": "com.amazonaws.ssoadmin#NameType", + "target": "com.amazonaws.ssoadmin#ApplicationNameType", "traits": { "smithy.api#documentation": "Specifies the updated name for the application.
" } @@ -8667,7 +8677,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
\nUpdating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.
\nUpdates the name of the trusted token issuer, or the path of a source attribute or destination\n attribute for a trusted token issuer configuration.
\nUpdating this trusted token issuer configuration might cause users to lose access to any\n applications that are configured to use the trusted token issuer.
\nThe name space of the dataset.
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe custom schema of the data lake dataset and is only required when the name space is default.
" + "smithy.api#documentation": "The custom schema of the data lake dataset and required for dataset in default and custom namespaces.
" } }, "description": { @@ -801,6 +871,12 @@ "smithy.api#documentation": "The description of the dataset.
" } }, + "partitionSpec": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionSpec", + "traits": { + "smithy.api#documentation": "The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.
" + } + }, "tags": { "target": "com.amazonaws.supplychain#TagMap", "traits": { @@ -831,6 +907,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.supplychain#CreateDataLakeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#CreateDataLakeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#CreateDataLakeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#ConflictException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.
", + "smithy.api#examples": [ + { + "title": "Create a data lake namespace", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "description": "This is my AWS Supply Chain namespace", + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + } + }, + "output": { + "namespace": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "description": "This is my AWS Supply Chain namespace", + "createdTime": 1736892560.751, + "lastModifiedTime": 1736892560.751 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#CreateDataLakeNamespaceRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The name of the namespace. Noted you cannot create namespace with name starting with asc, default, scn, aws, amazon, amzn\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceDescription", + "traits": { + "smithy.api#documentation": "The description of the namespace.
" + } + }, + "tags": { + "target": "com.amazonaws.supplychain#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the namespace.
", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters for CreateDataLakeNamespace.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#CreateDataLakeNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeNamespace", + "traits": { + "smithy.api#documentation": "The detail of created namespace.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of CreateDataLakeNamespace.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#CreateInstance": { "type": "operation", "input": { @@ -974,107 +1167,276 @@ "smithy.api#output": {} } }, - "com.amazonaws.supplychain#DataIntegrationEventData": { + "com.amazonaws.supplychain#DataIntegrationDatasetArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 1048576 + "min": 20, + "max": 1011 }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.supplychain#DataIntegrationEventGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } + "smithy.api#pattern": "^arn:aws:scn:([a-z0-9-]+):([0-9]+):instance/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/namespaces/[^/]+/datasets/[^/]+$" } }, - "com.amazonaws.supplychain#DataIntegrationEventResource": { - "type": "resource", - "identifiers": { + "com.amazonaws.supplychain#DataIntegrationEvent": { + "type": "structure", + "members": { "instanceId": { - "target": "com.amazonaws.supplychain#UUID" + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#required": {} + } }, "eventId": { - "target": "com.amazonaws.supplychain#UUID" - } - }, - "properties": { - "eventType": { - "target": "com.amazonaws.supplychain#DataIntegrationEventType" + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The unique event identifier.
", + "smithy.api#required": {} + } }, - "data": { - "target": "com.amazonaws.supplychain#DataIntegrationEventData" + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType", + "traits": { + "smithy.api#documentation": "The data event type.
", + "smithy.api#required": {} + } }, "eventGroupId": { - "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId" + "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId", + "traits": { + "smithy.api#documentation": "Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
", + "smithy.api#required": {} + } }, "eventTimestamp": { - "target": "smithy.api#Timestamp" + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The event timestamp (in epoch seconds).
", + "smithy.api#required": {} + } + }, + "datasetTargetDetails": { + "target": "com.amazonaws.supplychain#DataIntegrationEventDatasetTargetDetails", + "traits": { + "smithy.api#documentation": "The target dataset details for a DATASET event type.
" + } } }, - "create": { - "target": "com.amazonaws.supplychain#SendDataIntegrationEvent" - }, "traits": { - "aws.api#arn": { - "template": "instance/{instanceId}/data-integration-events/{eventId}" + "smithy.api#documentation": "The data integration event details.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationEventData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.supplychain#DataIntegrationEventDatasetLoadExecutionDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.supplychain#DataIntegrationEventDatasetLoadStatus", + "traits": { + "smithy.api#documentation": "The event load execution status to target dataset.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The failure message (if any) of failed event load execution to dataset.
" + } } + }, + "traits": { + "smithy.api#documentation": "The target dataset load execution details.
" } }, - "com.amazonaws.supplychain#DataIntegrationEventType": { + "com.amazonaws.supplychain#DataIntegrationEventDatasetLoadStatus": { "type": "enum", "members": { - "FORECAST": { + "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.forecast" + "smithy.api#enumValue": "SUCCEEDED" } }, - "INVENTORY_LEVEL": { + "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.inventorylevel" + "smithy.api#enumValue": "IN_PROGRESS" } }, - "INBOUND_ORDER": { + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.inboundorder" + "smithy.api#enumValue": "FAILED" } - }, - "INBOUND_ORDER_LINE": { + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventDatasetOperationType": { + "type": "enum", + "members": { + "APPEND": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.inboundorderline" + "smithy.api#enumValue": "APPEND" } }, - "INBOUND_ORDER_LINE_SCHEDULE": { + "UPSERT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.inboundorderlineschedule" + "smithy.api#enumValue": "UPSERT" } }, - "OUTBOUND_ORDER_LINE": { + "DELETE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "scn.data.outboundorderline" + "smithy.api#enumValue": "DELETE" } - }, - "OUTBOUND_SHIPMENT": { - "target": "smithy.api#Unit", + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventDatasetTargetConfiguration": { + "type": "structure", + "members": { + "datasetIdentifier": { + "target": "com.amazonaws.supplychain#DataIntegrationDatasetArn", "traits": { - "smithy.api#enumValue": "scn.data.outboundshipment" + "smithy.api#documentation": "The datalake dataset ARN identifier.
", + "smithy.api#required": {} } }, - "PROCESS_HEADER": { - "target": "smithy.api#Unit", + "operationType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventDatasetOperationType", "traits": { - "smithy.api#enumValue": "scn.data.processheader" + "smithy.api#documentation": "The target dataset load operation type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The target dataset configuration for a DATASET event type.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationEventDatasetTargetDetails": { + "type": "structure", + "members": { + "datasetIdentifier": { + "target": "com.amazonaws.supplychain#DataIntegrationDatasetArn", + "traits": { + "smithy.api#documentation": "The datalake dataset ARN identifier.
", + "smithy.api#required": {} + } + }, + "operationType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventDatasetOperationType", + "traits": { + "smithy.api#documentation": "The target dataset load operation type. The available options are:
\n\n APPEND - Add new records to the dataset. Noted that this operation type will just try to append records as-is without any primary key or partition constraints.
\n\n UPSERT - Modify existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be updated. If primary keys do not match, new records will be added. Note that if dataset contain records with duplicate primary key values in the same partition, those duplicate records will be deduped into one updated record.
\n\n DELETE - Remove existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be deleted. If primary keys do not match, no actions will be done. Note that if dataset contain records with duplicate primary key values in the same partition, all those duplicates will be removed.
\nThe target dataset load execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The target dataset details for a DATASET event type.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationEventGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataIntegrationEvent" + } + }, + "com.amazonaws.supplychain#DataIntegrationEventMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventType": { + "type": "enum", + "members": { + "FORECAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.forecast" + } + }, + "INVENTORY_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inventorylevel" + } + }, + "INBOUND_ORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorder" + } + }, + "INBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderline" + } + }, + "INBOUND_ORDER_LINE_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderlineschedule" + } + }, + "OUTBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundorderline" + } + }, + "OUTBOUND_SHIPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundshipment" + } + }, + "PROCESS_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processheader" } }, "PROCESS_OPERATION": { @@ -1118,6 +1480,12 @@ "traits": { "smithy.api#enumValue": "scn.data.supplyplan" } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.dataset" + } } } }, @@ -1186,13 +1554,19 @@ "loadType": { "target": "com.amazonaws.supplychain#DataIntegrationFlowLoadType", "traits": { - "smithy.api#documentation": "The dataset data load type in dataset options.
" + "smithy.api#documentation": "The target dataset's data load type. This only affects how source S3 files are selected in the S3-to-dataset flow.
\n\n REPLACE - Target dataset will get replaced with the new file added under the source s3 prefix.
\n\n INCREMENTAL - Target dataset will get updated with the up-to-date content under S3 prefix incorporating any file additions or removals there.
\nThe dataset load option to remove duplicates.
" + "smithy.api#documentation": "The option to perform deduplication on data records sharing same primary key values. If disabled, transformed data with duplicate primary key values will ingest into dataset, for datasets within asc namespace, such duplicates will cause ingestion fail. If enabled without dedupeStrategy, deduplication is done by retaining a random data record among those sharing the same primary key values. If enabled with dedupeStragtegy, the deduplication is done following the strategy.
\nNote that target dataset may have partition configured, when dedupe is enabled, it only dedupe against primary keys and retain only one record out of those duplicates regardless of its partition status.
" + } + }, + "dedupeStrategy": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDedupeStrategy", + "traits": { + "smithy.api#documentation": "The deduplication strategy to dedupe the data records sharing same primary key values of the target dataset. This strategy only applies to target dataset with primary keys and with dedupeRecords option enabled. If transformed data still got duplicates after the dedupeStrategy evaluation, a random data record is chosen to be retained.
" } } }, @@ -1200,6 +1574,21 @@ "smithy.api#documentation": "The dataset options used in dataset source and target configurations.
" } }, + "com.amazonaws.supplychain#DataIntegrationFlowDatasetSource": { + "type": "structure", + "members": { + "datasetIdentifier": { + "target": "com.amazonaws.supplychain#DataIntegrationDatasetArn", + "traits": { + "smithy.api#documentation": "The ARN of the dataset source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a flow execution with dataset source.
" + } + }, "com.amazonaws.supplychain#DataIntegrationFlowDatasetSourceConfiguration": { "type": "structure", "members": { @@ -1227,19 +1616,290 @@ "datasetIdentifier": { "target": "com.amazonaws.supplychain#DatasetIdentifier", "traits": { - "smithy.api#documentation": "The dataset ARN.
", + "smithy.api#documentation": "The dataset ARN.
", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetOptions", + "traits": { + "smithy.api#documentation": "The dataset DataIntegrationFlow target options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The dataset DataIntegrationFlow target configuration parameters.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowDedupeStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDedupeStrategyType", + "traits": { + "smithy.api#documentation": "The type of the deduplication strategy.
\n\n FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger or smaller field value.
\nThe field priority deduplication strategy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The deduplication strategy details.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowDedupeStrategyType": { + "type": "enum", + "members": { + "FIELD_PRIORITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_PRIORITY" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecution": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The flow execution's instanceId.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "instanceId" + } + }, + "flowName": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "The flow execution's flowName.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "flowName" + } + }, + "executionId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The flow executionId.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "executionId" + } + }, + "status": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of flow execution.
" + } + }, + "sourceInfo": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionSourceInfo", + "traits": { + "smithy.api#documentation": "The source information for a flow execution.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The failure message (if any) of failed flow execution.
" + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The flow execution start timestamp.
" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The flow execution end timestamp.
" + } + }, + "outputMetadata": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionOutputMetadata", + "traits": { + "smithy.api#documentation": "The flow execution output metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The flow execution details.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionDiagnosticReportsRootS3URI": { + "type": "string", + "traits": { + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecution" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionOutputMetadata": { + "type": "structure", + "members": { + "diagnosticReportsRootS3URI": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionDiagnosticReportsRootS3URI", + "traits": { + "smithy.api#documentation": "The S3 URI under which all diagnostic files (such as deduped records if any) are stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output metadata of the flow execution.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionSourceInfo": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceType", + "traits": { + "smithy.api#documentation": "The data integration flow execution source type.
", + "smithy.api#required": {} + } + }, + "s3Source": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Source", + "traits": { + "smithy.api#documentation": "The source details of a flow execution with S3 source.
" + } + }, + "datasetSource": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetSource", + "traits": { + "smithy.api#documentation": "The source details of a flow execution with dataset source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source information of a flow execution.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowExecutionStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeFieldName", + "traits": { + "smithy.api#documentation": "The name of the deduplication field. Must exist in the dataset and not be a primary key.
", + "smithy.api#required": {} + } + }, + "sortOrder": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeSortOrder", + "traits": { + "smithy.api#documentation": "The sort order for the deduplication field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The field used in the field priority deduplication strategy.
" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-z0-9_]+$" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeSortOrder": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowFieldPriorityDedupeFieldList", + "traits": { + "smithy.api#documentation": "The list of field names and their sort order for deduplication, arranged in descending priority from highest to lowest.
", "smithy.api#required": {} } - }, - "options": { - "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetOptions", - "traits": { - "smithy.api#documentation": "The dataset DataIntegrationFlow target options.
" - } } }, "traits": { - "smithy.api#documentation": "The dataset DataIntegrationFlow target configuration parameters.
" + "smithy.api#documentation": "The field priority deduplication strategy details.
" } }, "com.amazonaws.supplychain#DataIntegrationFlowFileType": { @@ -1392,6 +2052,28 @@ "smithy.api#pattern": "^[/A-Za-z0-9._-]+$" } }, + "com.amazonaws.supplychain#DataIntegrationFlowS3Source": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.supplychain#S3BucketName", + "traits": { + "smithy.api#documentation": "The S3 bucket name of the S3 source.
", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.supplychain#DataIntegrationS3ObjectKey", + "traits": { + "smithy.api#documentation": "The S3 object key of the S3 source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a flow execution with S3 source.
" + } + }, "com.amazonaws.supplychain#DataIntegrationFlowS3SourceConfiguration": { "type": "structure", "members": { @@ -1405,7 +2087,7 @@ "prefix": { "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Prefix", "traits": { - "smithy.api#documentation": "The prefix of the S3 source objects.
", + "smithy.api#documentation": "The prefix of the S3 source objects. To trigger data ingestion, S3 files need to be put under s3://bucketName/prefix/.
The dataset DataIntegrationFlow target.
" + "smithy.api#documentation": "The dataset DataIntegrationFlow target. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
" } } }, @@ -1627,6 +2310,16 @@ } } }, + "com.amazonaws.supplychain#DataIntegrationS3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[/A-Za-z0-9._:*()'!=?&+;@-]+$" + } + }, "com.amazonaws.supplychain#DataLakeDataset": { "type": "structure", "members": { @@ -1639,9 +2332,9 @@ } }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", "traits": { - "smithy.api#documentation": "The name space of the dataset. The available values are:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "smithy.api#documentation": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "name" } @@ -1674,6 +2367,9 @@ "smithy.api#documentation": "The description of the dataset.
" } }, + "partitionSpec": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionSpec" + }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { @@ -1709,7 +2405,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 20 } } @@ -1734,22 +2430,138 @@ "smithy.api#pattern": "^[a-z0-9_]+$" } }, - "com.amazonaws.supplychain#DataLakeDatasetNamespace": { + "com.amazonaws.supplychain#DataLakeDatasetNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPartitionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName", + "traits": { + "smithy.api#documentation": "The name of the partition field.
", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^[a-z]+$" + "transform": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionFieldTransform", + "traits": { + "smithy.api#documentation": "The transformation of the partition field. A transformation specifies how to partition on a given field. For example, with timestamp you can specify that you'd like to partition fields by day, e.g. data record with value 2025-01-03T00:00:00Z in partition field is in 2025-01-03 partition. Also noted that data record without any value in optional partition field is in NULL partition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The detail of the partition field.
" } }, - "com.amazonaws.supplychain#DataLakeDatasetNextToken": { - "type": "string", + "com.amazonaws.supplychain#DataLakeDatasetPartitionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionField" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 65535 + "max": 10 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPartitionFieldTransform": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionTransformType", + "traits": { + "smithy.api#documentation": "The type of partitioning transformation for this field. The available options are:
\n\n IDENTITY - Partitions data on a given field by its exact values.
\n\n YEAR - Partitions data on a timestamp field using year granularity.
\n\n MONTH - Partitions data on a timestamp field using month granularity.
\n\n DAY - Partitions data on a timestamp field using day granularity.
\n\n HOUR - Partitions data on a timestamp field using hour granularity.
\nThe detail of the partition field transformation.
" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPartitionSpec": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionFieldList", + "traits": { + "smithy.api#documentation": "The fields on which to partition a dataset. The partitions will be applied hierarchically based on the order of this list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The partition specification for a dataset.
" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPartitionTransformType": { + "type": "enum", + "members": { + "YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEAR" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "IDENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY" + } + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPrimaryKeyField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName", + "traits": { + "smithy.api#documentation": "The name of the primary key field.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The detail of the primary key field.
" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetPrimaryKeyFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPrimaryKeyField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 } } }, @@ -1760,7 +2572,7 @@ "target": "com.amazonaws.supplychain#UUID" }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace" + "target": "com.amazonaws.supplychain#DataLakeNamespaceName" }, "name": { "target": "com.amazonaws.supplychain#DataLakeDatasetName" @@ -1781,6 +2593,9 @@ }, "lastModifiedTime": { "target": "smithy.api#Timestamp" + }, + "partitionSpec": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPartitionSpec" } }, "put": { @@ -1824,10 +2639,16 @@ "smithy.api#documentation": "The list of field details of the dataset schema.
", "smithy.api#required": {} } + }, + "primaryKeys": { + "target": "com.amazonaws.supplychain#DataLakeDatasetPrimaryKeyFieldList", + "traits": { + "smithy.api#documentation": "The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations.
\nNote that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation.
" + } } }, "traits": { - "smithy.api#documentation": "The schema details of the dataset.
" + "smithy.api#documentation": "The schema details of the dataset. Note that for AWS Supply Chain dataset under asc namespace, it may have internal fields like connection_id that will be auto populated by data ingestion methods.
" } }, "com.amazonaws.supplychain#DataLakeDatasetSchemaField": { @@ -1865,59 +2686,212 @@ "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaField" }, "traits": { - "smithy.api#length": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-z0-9_]+$" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldType": { + "type": "enum", + "members": { + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INT" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONG" + } + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.supplychain#DataLakeNamespace": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "instanceId" + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The name of the namespace.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "name" + } + }, + "arn": { + "target": "com.amazonaws.supplychain#AscResourceArn", + "traits": { + "smithy.api#documentation": "The arn of the namespace.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceDescription", + "traits": { + "smithy.api#documentation": "The description of the namespace.
" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the namespace.
", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The last modified time of the namespace.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The data lake namespace details.
" + } + }, + "com.amazonaws.supplychain#DataLakeNamespaceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.supplychain#DataLakeNamespaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataLakeNamespace" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataLakeNamespaceMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { "min": 1, - "max": 500 + "max": 20 } } }, - "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName": { + "com.amazonaws.supplychain#DataLakeNamespaceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 50 }, "smithy.api#pattern": "^[a-z0-9_]+$" } }, - "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldType": { - "type": "enum", - "members": { - "INT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INT" - } + "com.amazonaws.supplychain#DataLakeNamespaceNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataLakeNamespaceResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" }, - "DOUBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOUBLE" - } + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName" + } + }, + "properties": { + "arn": { + "target": "com.amazonaws.supplychain#AscResourceArn" }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } + "description": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceDescription" }, - "TIMESTAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMESTAMP" - } + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp" } - } - }, - "com.amazonaws.supplychain#DataLakeDatasetSchemaName": { - "type": "string", + }, + "put": { + "target": "com.amazonaws.supplychain#CreateDataLakeNamespace" + }, + "read": { + "target": "com.amazonaws.supplychain#GetDataLakeNamespace" + }, + "update": { + "target": "com.amazonaws.supplychain#UpdateDataLakeNamespace" + }, + "delete": { + "target": "com.amazonaws.supplychain#DeleteDataLakeNamespace" + }, + "list": { + "target": "com.amazonaws.supplychain#ListDataLakeNamespaces" + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + "aws.api#arn": { + "template": "instance/{instanceId}/namespaces/{name}" }, - "smithy.api#pattern": "^[A-Za-z0-9]+$" + "smithy.api#noReplace": {} } }, "com.amazonaws.supplychain#DatasetIdentifier": { @@ -2098,9 +3072,9 @@ } }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", "traits": { - "smithy.api#documentation": "The name space of the dataset. The available values are:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "smithy.api#documentation": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2130,9 +3104,9 @@ } }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", "traits": { - "smithy.api#documentation": "The name space of deleted dataset.
", + "smithy.api#documentation": "The namespace of deleted dataset.
", "smithy.api#required": {} } }, @@ -2149,6 +3123,102 @@ "smithy.api#output": {} } }, + "com.amazonaws.supplychain#DeleteDataLakeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#DeleteDataLakeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#DeleteDataLakeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.
", + "smithy.api#examples": [ + { + "title": "Delete an AWS Supply Chain namespace", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace" + }, + "output": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#DeleteDataLakeNamespaceRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters of DeleteDataLakeNamespace.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#DeleteDataLakeNamespaceResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The name of deleted namespace.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of DeleteDataLakeNamespace.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#DeleteInstance": { "type": "operation", "input": { @@ -2243,9 +3313,24 @@ "type": "service", "version": "2024-01-01", "operations": [ + { + "target": "com.amazonaws.supplychain#GetDataIntegrationEvent" + }, + { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlowExecution" + }, + { + "target": "com.amazonaws.supplychain#ListDataIntegrationEvents" + }, + { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlowExecutions" + }, { "target": "com.amazonaws.supplychain#ListTagsForResource" }, + { + "target": "com.amazonaws.supplychain#SendDataIntegrationEvent" + }, { "target": "com.amazonaws.supplychain#TagResource" }, @@ -2257,15 +3342,15 @@ { "target": "com.amazonaws.supplychain#BillOfMaterialsImportJobResource" }, - { - "target": "com.amazonaws.supplychain#DataIntegrationEventResource" - }, { "target": "com.amazonaws.supplychain#DataIntegrationFlowResource" }, { "target": "com.amazonaws.supplychain#DataLakeDatasetResource" }, + { + "target": "com.amazonaws.supplychain#DataLakeNamespaceResource" + }, { "target": "com.amazonaws.supplychain#InstanceResource" } @@ -3032,17 +4117,119 @@ } }, { - "title": "Invoke GetBillOfMaterialsImportJob for an in-progress job", + "title": "Invoke GetBillOfMaterialsImportJob for an in-progress job", + "input": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" + }, + "output": { + "job": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", + "status": "IN_PROGRESS", + "s3uri": "s3://mybucketname/pathelemene/file.csv" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/configuration/instances/{instanceId}/bill-of-materials-import-jobs/{jobId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The BillOfMaterialsImportJob identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters for GetBillOfMaterialsImportJob.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.supplychain#BillOfMaterialsImportJob", + "traits": { + "smithy.api#documentation": "The BillOfMaterialsImportJob.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters for GetBillOfMaterialsImportJob.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetDataIntegrationEventRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetDataIntegrationEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
", + "smithy.api#examples": [ + { + "title": "Successful GetDataIntegrationEvent", "input": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042" }, "output": { - "job": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", - "status": "IN_PROGRESS", - "s3uri": "s3://mybucketname/pathelemene/file.csv" + "event": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042", + "eventType": "scn.data.dataset", + "eventGroupId": "datasetId", + "eventTimestamp": 1515531081.123, + "datasetTargetDetails": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "operationType": "APPEND", + "datasetLoadExecution": { + "status": "SUCCEEDED" + } + } } } } @@ -3050,50 +4237,50 @@ "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/api/configuration/instances/{instanceId}/bill-of-materials-import-jobs/{jobId}" + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-events/{eventId}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest": { + "com.amazonaws.supplychain#GetDataIntegrationEventRequest": { "type": "structure", "members": { "instanceId": { "target": "com.amazonaws.supplychain#UUID", "traits": { - "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "jobId": { + "eventId": { "target": "com.amazonaws.supplychain#UUID", "traits": { - "smithy.api#documentation": "The BillOfMaterialsImportJob identifier.
", + "smithy.api#documentation": "The unique event identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The request parameters for GetBillOfMaterialsImportJob.
", + "smithy.api#documentation": "The request parameters for GetDataIntegrationEvent.
", "smithy.api#input": {} } }, - "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse": { + "com.amazonaws.supplychain#GetDataIntegrationEventResponse": { "type": "structure", "members": { - "job": { - "target": "com.amazonaws.supplychain#BillOfMaterialsImportJob", + "event": { + "target": "com.amazonaws.supplychain#DataIntegrationEvent", "traits": { - "smithy.api#documentation": "The BillOfMaterialsImportJob.
", + "smithy.api#documentation": "The details of the DataIntegrationEvent returned.
", "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The response parameters for GetBillOfMaterialsImportJob.
", + "smithy.api#documentation": "The response parameters for GetDataIntegrationEvent.
", "smithy.api#output": {} } }, @@ -3171,6 +4358,142 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.supplychain#GetDataIntegrationFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the flow execution.
", + "smithy.api#examples": [ + { + "title": "Successful GetDataIntegrationFlowExecution for S3 source", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "source-product", + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7" + }, + "output": { + "flowExecution": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "source-product", + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7", + "status": "SUCCEEDED", + "sourceInfo": { + "sourceType": "S3", + "s3Source": { + "bucketName": "galaxy-raw-input-test-data-prod-pdx-1", + "key": "sources/product-sources.csv" + } + }, + "startTime": 1515531081.123, + "endTime": 1515531090.123 + } + } + }, + { + "title": "Successful GetDataIntegrationFlowExecution for DATASET source", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "target-product", + "executionId": "9daf6071-d12c-4eef-864c-73cea2557825" + }, + "output": { + "flowExecution": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "target-product", + "executionId": "9daf6071-d12c-4eef-864c-73cea2557825", + "status": "SUCCEEDED", + "sourceInfo": { + "sourceType": "DATASET", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/default/datasets/product" + } + }, + "startTime": 1515531081.123, + "endTime": 1515531090.123 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-flows/{flowName}/executions/{executionId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationFlowExecutionRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowName": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "The flow name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The flow execution identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters of GetFlowExecution.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationFlowExecutionResponse": { + "type": "structure", + "members": { + "flowExecution": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecution", + "traits": { + "smithy.api#documentation": "The flow execution details.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of GetFlowExecution.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#GetDataIntegrationFlowRequest": { "type": "structure", "members": { @@ -3416,46 +4739,192 @@ } }, { - "title": "Get proporties of an existing custom dataset", + "title": "Get proporties of an existing custom dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset" + }, + "output": { + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is a custom dataset", + "createdTime": 1727116807.751, + "lastModifiedTime": 1727116807.751, + "schema": { + "name": "MyDataset", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + }, + { + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" + } + ] + }, + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + } + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeDatasetRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters for GetDataLakeDataset.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeDatasetResponse": { + "type": "structure", + "members": { + "dataset": { + "target": "com.amazonaws.supplychain#DataLakeDataset", + "traits": { + "smithy.api#documentation": "The fetched dataset details.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters for GetDataLakeDataset.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetDataLakeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetDataLakeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.
", + "smithy.api#examples": [ + { + "title": "Get properties of an existing AWS Supply Chain namespace", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace" + }, + "output": { + "namespace": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "description": "This is my AWS Supply Chain namespace", + "createdTime": 1736892560.751, + "lastModifiedTime": 1736892560.751 + } + } + }, + { + "title": "Get proporties of an existing pre-defined AWS Supply Chain namespace", "input": { "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", - "namespace": "default", - "name": "my_dataset" + "name": "asc" }, "output": { - "dataset": { - "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "namespace": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc", "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", - "namespace": "default", - "name": "my_dataset", - "description": "This is a custom dataset", - "createdTime": 1727116807.751, - "lastModifiedTime": 1727116807.751, - "schema": { - "name": "MyDataset", - "fields": [ - { - "name": "id", - "type": "INT", - "isRequired": true - }, - { - "name": "description", - "type": "STRING", - "isRequired": true - }, - { - "name": "price", - "type": "DOUBLE", - "isRequired": false - }, - { - "name": "creation_time", - "type": "TIMESTAMP", - "isRequired": false - } - ] - } + "name": "asc", + "createdTime": 1736892430.234, + "lastModifiedTime": 1736892430.234 } } } @@ -3463,12 +4932,12 @@ "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + "uri": "/api/datalake/instance/{instanceId}/namespaces/{name}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.supplychain#GetDataLakeDatasetRequest": { + "com.amazonaws.supplychain#GetDataLakeNamespaceRequest": { "type": "structure", "members": { "instanceId": { @@ -3479,42 +4948,34 @@ "smithy.api#required": {} } }, - "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", - "traits": { - "smithy.api#documentation": "The name space of the dataset. The available values are:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "smithy.api#documentation": "The name of the namespace. Besides the namespaces user created, you can also specify the pre-defined namespaces:
\n\n asc - Pre-defined namespace containing Amazon Web Services Supply Chain supported datasets, see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - Pre-defined namespace containing datasets with custom user-defined schemas.
\nThe request parameters for GetDataLakeDataset.
", + "smithy.api#documentation": "The request parameters for GetDataLakeNamespace.
", "smithy.api#input": {} } }, - "com.amazonaws.supplychain#GetDataLakeDatasetResponse": { + "com.amazonaws.supplychain#GetDataLakeNamespaceResponse": { "type": "structure", "members": { - "dataset": { - "target": "com.amazonaws.supplychain#DataLakeDataset", + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeNamespace", "traits": { - "smithy.api#documentation": "The fetched dataset details.
", + "smithy.api#documentation": "The fetched namespace details.
", "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The response parameters for UpdateDataLakeDataset.
", + "smithy.api#documentation": "The response parameters for GetDataLakeNamespace.
", "smithy.api#output": {} } }, @@ -3899,13 +5360,269 @@ "smithy.api#retryable": {} } }, - "com.amazonaws.supplychain#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.supplychain#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:key/.{0,1019}$" + } + }, + "com.amazonaws.supplychain#ListDataIntegrationEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListDataIntegrationEventsRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListDataIntegrationEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
", + "smithy.api#examples": [ + { + "title": "Successful ListDataIntegrationEvents", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "events": [ + { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042", + "eventType": "scn.data.dataset", + "eventGroupId": "datasetId", + "eventTimestamp": 1515531081.123, + "datasetTargetDetails": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "operationType": "APPEND", + "datasetLoadExecution": { + "status": "SUCCEEDED" + } + } + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-events" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "events" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationEventsRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType", + "traits": { + "smithy.api#documentation": "List data integration events for the specified eventType.
", + "smithy.api#httpQuery": "eventType" + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationEventNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch the next page of the data integration events.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#DataIntegrationEventMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "Specify the maximum number of data integration events to fetch in one paginated request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters for ListDataIntegrationEvents.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationEventsResponse": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.supplychain#DataIntegrationEventList", + "traits": { + "smithy.api#documentation": "The list of data integration events.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationEventNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch the next page of the ListDataIntegrationEvents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters for ListDataIntegrationEvents.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlowExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlowExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlowExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List flow executions.
", + "smithy.api#examples": [ + { + "title": "Successful ListDataIntegrationFlowExecutions", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "source-product" + }, + "output": { + "flowExecutions": [ + { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "flowName": "source-product", + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7", + "status": "SUCCEEDED", + "sourceInfo": { + "sourceType": "S3", + "s3Source": { + "bucketName": "galaxy-raw-input-test-data-prod-pdx-1", + "key": "sources/product-sources.csv" + } + }, + "startTime": 1515531081.123, + "endTime": 1515531090.123 + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-flows/{flowName}/executions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowExecutions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlowExecutionsRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The AWS Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowName": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "The flow name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch next page of flow executions.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "The number to specify the max number of flow executions to fetch in this paginated request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters of ListFlowExecutions.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlowExecutionsResponse": { + "type": "structure", + "members": { + "flowExecutions": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionList", + "traits": { + "smithy.api#documentation": "The list of flow executions.
", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:key/.{0,1019}$" + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowExecutionNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch next page of flow executions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of ListFlowExecutions.
", + "smithy.api#output": {} } }, "com.amazonaws.supplychain#ListDataIntegrationFlows": { @@ -3996,7 +5713,22 @@ "target": { "targetType": "DATASET", "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "loadType": "REPLACE", + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "DESC" + } + ] + } + } + } } }, "createdTime": 17235763506.88, @@ -4317,6 +6049,32 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" + } + ] + }, + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } } ] } @@ -4376,9 +6134,9 @@ } }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", "traits": { - "smithy.api#documentation": "The name space of the dataset. The available values are:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nEnables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.
", + "smithy.api#examples": [ + { + "title": "List AWS Supply Chain namespaces", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "namespaces": [ + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/custom_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "custom_namespace", + "createdTime": 1736892060.751, + "lastModifiedTime": 1736892060.751 + }, + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "createdTime": 1736892560.751, + "lastModifiedTime": 1736892586.156 + } + ] + } + }, + { + "title": "List AWS Supply Chain namespaces using pagination", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "maxResults": 1, + "nextToken": "next_token_returned_from_previous_list_request" + }, + "output": { + "namespaces": [ + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "createdTime": 1736892560.751, + "lastModifiedTime": 1736892586.156 + } + ], + "nextToken": "next_token_for_next_list_request" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/datalake/instance/{instanceId}/namespaces" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "namespaces" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListDataLakeNamespacesRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Supply Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch next page of namespaces.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "The max number of namespaces to fetch in this paginated request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters of ListDataLakeNamespaces.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListDataLakeNamespacesResponse": { + "type": "structure", + "members": { + "namespaces": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceList", + "traits": { + "smithy.api#documentation": "The list of fetched namespace details. Noted it only contains custom namespaces, pre-defined namespaces are not included.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceNextToken", + "traits": { + "smithy.api#documentation": "The pagination token to fetch next page of namespaces.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of ListDataLakeNamespaces.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#ListInstances": { "type": "operation", "input": { @@ -4759,7 +6655,7 @@ } ], "traits": { - "smithy.api#documentation": "Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
", + "smithy.api#documentation": "Send the data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake.
", "smithy.api#examples": [ { "title": "Successful SendDataIntegrationEvent for inboundorder event type", @@ -4955,6 +6851,23 @@ "output": { "eventId": "9abaee56-5dc4-4c31-8250-3206a651d8a1" } + }, + { + "title": "Successful SendDataIntegrationEvent for dataset event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.dataset", + "data": "{\"dataset_id\": \"datset-id-test-123\" }", + "eventGroupId": "datasetId", + "eventTimestamp": 1515531081.123, + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "operationType": "APPEND" + } + }, + "output": { + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042" + } } ], "smithy.api#http": { @@ -4979,37 +6892,43 @@ "eventType": { "target": "com.amazonaws.supplychain#DataIntegrationEventType", "traits": { - "smithy.api#documentation": "The data event type.
", + "smithy.api#documentation": "The data event type.
\n\n scn.data.dataset - Send data directly to any specified dataset.
\n\n scn.data.supplyplan - Send data to supply_plan dataset.
\n\n scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.
\n\n scn.data.shipmentstop - Send data to shipment_stop dataset.
\n\n scn.data.shipment - Send data to shipment dataset.
\n\n scn.data.reservation - Send data to reservation dataset.
\n\n scn.data.processproduct - Send data to process_product dataset.
\n\n scn.data.processoperation - Send data to process_operation dataset.
\n\n scn.data.processheader - Send data to process_header dataset.
\n\n scn.data.forecast - Send data to forecast dataset.
\n\n scn.data.inventorylevel - Send data to inv_level dataset.
\n\n scn.data.inboundorder - Send data to inbound_order dataset.
\n\n scn.data.inboundorderline - Send data to inbound_order_line dataset.
\n\n scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.
\n\n scn.data.outboundorderline - Send data to outbound_order_line dataset.
\n\n scn.data.outboundshipment - Send data to outbound_shipment dataset.
\nThe data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain.
", + "smithy.api#documentation": "The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.
\nNote that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
", "smithy.api#required": {} } }, "eventGroupId": { "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId", "traits": { - "smithy.api#documentation": "Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
", + "smithy.api#documentation": "Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.
", "smithy.api#required": {} } }, "eventTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The event timestamp (in epoch seconds).
", + "smithy.api#documentation": "The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.
", "smithy.api#timestampFormat": "epoch-seconds" } }, "clientToken": { "target": "com.amazonaws.supplychain#ClientToken", "traits": { - "smithy.api#documentation": "The idempotent client token.
", + "smithy.api#documentation": "The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.
", "smithy.api#idempotencyToken": {} } + }, + "datasetTarget": { + "target": "com.amazonaws.supplychain#DataIntegrationEventDatasetTargetConfiguration", + "traits": { + "smithy.api#documentation": "The target dataset configuration for scn.data.dataset event type.
" + } } }, "traits": { @@ -5392,7 +7311,22 @@ "target": { "targetType": "DATASET", "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "loadType": "REPLACE", + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "ASC" + } + ] + } + } + } } } }, @@ -5425,7 +7359,22 @@ "target": { "targetType": "DATASET", "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "loadType": "REPLACE", + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "ASC" + } + ] + } + } + } } }, "createdTime": 1724956400.44, @@ -5743,6 +7692,32 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" + } + ] + }, + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } } ] } @@ -5769,9 +7744,9 @@ } }, "namespace": { - "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", "traits": { - "smithy.api#documentation": "The name space of the dataset. The available values are:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
\n\n asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
\n\n default - For datasets with custom user-defined schemas.
\nThe name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "smithy.api#documentation": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5813,6 +7788,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.supplychain#UpdateDataLakeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#UpdateDataLakeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#UpdateDataLakeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.
", + "smithy.api#examples": [ + { + "title": "Update description of an existing AWS Supply Chain namespace", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "description": "This is an updated AWS Supply Chain namespace" + }, + "output": { + "namespace": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "name": "my_namespace", + "description": "This is an updated AWS Supply Chain namespace", + "createdTime": 1736892560.751, + "lastModifiedTime": 1736892586.156 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{name}" + } + } + }, + "com.amazonaws.supplychain#UpdateDataLakeNamespaceRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Chain instance identifier.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceName", + "traits": { + "smithy.api#documentation": "The name of the namespace. Noted you cannot update namespace with name starting with asc, default, scn, aws, amazon, amzn\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeNamespaceDescription", + "traits": { + "smithy.api#documentation": "The updated description of the data lake namespace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request parameters of UpdateDataLakeNamespace.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#UpdateDataLakeNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeNamespace", + "traits": { + "smithy.api#documentation": "The updated namespace details.
", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The response parameters of UpdateDataLakeNamespace.
", + "smithy.api#output": {} + } + }, "com.amazonaws.supplychain#UpdateInstance": { "type": "operation", "input": { diff --git a/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json b/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json index 0e5e52b7..d48464a5 100644 --- a/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json +++ b/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json @@ -29,6 +29,19 @@ ] }, "shapes": { + "com.amazonaws.synthetics#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.synthetics#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You don't have permission to perform this operation on this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.synthetics#ArtifactConfigInput": { "type": "structure", "members": { @@ -236,13 +249,13 @@ "SuccessRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "The number of days to retain data about successful runs of this canary.
" + "smithy.api#documentation": "The number of days to retain data about successful runs of this canary.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "The number of days to retain data about failed runs of this canary.
" + "smithy.api#documentation": "The number of days to retain data about failed runs of this canary.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "Status": { @@ -301,6 +314,12 @@ "traits": { "smithy.api#documentation": "A structure that contains the configuration for canary artifacts, including \n the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
" } + }, + "DryRunConfig": { + "target": "com.amazonaws.synthetics#DryRunConfigOutput", + "traits": { + "smithy.api#documentation": "Returns the dry run configurations for a canary.
" + } } }, "traits": { @@ -353,7 +372,7 @@ } }, "traits": { - "smithy.api#documentation": "Use this structure to input your script code for the canary. This structure contains the\n Lambda handler with the location where the canary should start running the script. If the\n script is stored in an S3 bucket, the bucket name, key, and version are also included. If\n the script was passed into the canary directly, the script code is contained in the value\n of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your \n script in a certain folder structure.
\nFor Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js\n \n For more information, see Packaging your Node.js canary files\n
For Python canaries, the folder structure must be python/myCanaryFilename.p\n or python/myFolder/myCanaryFilename.py\n \n For more information, see Packaging your Python canary files\n
Use this structure to input your script code for the canary. This structure contains the\n Lambda handler with the location where the canary should start running the script. If the\n script is stored in an S3 bucket, the bucket name, key, and version are also included. If\n the script was passed into the canary directly, the script code is contained in the value\n of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your \n script in a certain folder structure.
\nFor Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js\n \n For more information, see Packaging your Node.js canary files\n
For Python canaries, the folder structure must be python/myCanaryFilename.py\n or python/myFolder/myCanaryFilename.py\n \n For more information, see Packaging your Python canary files\n
This structure contains information about the canary's Lambda handler and \n where its code is stored by CloudWatch Synthetics.
" } }, + "com.amazonaws.synthetics#CanaryDryRunConfigOutput": { + "type": "structure", + "members": { + "DryRunId": { + "target": "com.amazonaws.synthetics#UUID", + "traits": { + "smithy.api#documentation": "The DryRunId associated with an existing canary\u2019s dry run. You can use this DryRunId to retrieve information about the dry run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the dry run configurations set for a canary.
" + } + }, "com.amazonaws.synthetics#CanaryLastRun": { "type": "structure", "members": { @@ -415,6 +448,18 @@ "smithy.api#documentation": "A unique ID that identifies this canary run.
" } }, + "ScheduledRunId": { + "target": "com.amazonaws.synthetics#UUID", + "traits": { + "smithy.api#documentation": "The ID of the scheduled canary run.
" + } + }, + "RetryAttempt": { + "target": "com.amazonaws.synthetics#RetryAttempt", + "traits": { + "smithy.api#documentation": "The count in number of the retry attempt.
" + } + }, "Name": { "target": "com.amazonaws.synthetics#CanaryName", "traits": { @@ -438,6 +483,12 @@ "traits": { "smithy.api#documentation": "The location where the canary stored artifacts from the run. Artifacts include \n the log file, screenshots, and HAR files.
" } + }, + "DryRunConfig": { + "target": "com.amazonaws.synthetics#CanaryDryRunConfigOutput", + "traits": { + "smithy.api#documentation": "Returns the dry run configurations for a canary.
" + } } }, "traits": { @@ -468,7 +519,7 @@ "EnvironmentVariables": { "target": "com.amazonaws.synthetics#EnvironmentVariablesMap", "traits": { - "smithy.api#documentation": "Specifies the keys and values to use for any environment variables\n used in the canary script. Use the following format:
\n{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
\nKeys must start with a letter and be at least two characters. The total size\n of your environment variables cannot exceed 4 KB. You can't specify any Lambda\n reserved environment variables as the keys for your environment variables. For \n more information about reserved keys, see \n Runtime environment variables.
\nThe environment variables keys and values are not encrypted. Do not store sensitive information\n in this field.
\nSpecifies the keys and values to use for any environment variables\n used in the canary script. Use the following format:
\n{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
\nKeys must start with a letter and be at least two characters. The total size\n of your environment variables cannot exceed 4 KB. You can't specify any Lambda\n reserved environment variables as the keys for your environment variables. For \n more information about reserved keys, see \n Runtime environment variables.
\nEnvironment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables \n are not encrypted on the client side. Do not store sensitive information\n in them.
\nThe end time of the run.
" } + }, + "MetricTimestampForRunAndRetries": { + "target": "com.amazonaws.synthetics#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the metrics will be generated for this run or retries.
" + } } }, "traits": { @@ -609,6 +666,12 @@ "traits": { "smithy.api#documentation": "How long, in seconds, for the canary to continue making regular runs according to\n the schedule in the Expression value. If you specify 0, the canary continues\n making runs until you stop it. If you omit this field, the default of 0 is used.
A structure that contains the retry configuration for a canary
" + } } }, "traits": { @@ -629,6 +692,12 @@ "traits": { "smithy.api#documentation": "How long, in seconds, for the canary to continue making regular runs after it \n was created. The runs are performed according to the schedule in the \n Expression value.
A structure that contains the retry configuration for a canary
" + } } }, "traits": { @@ -783,13 +852,13 @@ "StateReason": { "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "If the canary has insufficient permissions to run, this field provides more details.
" + "smithy.api#documentation": "If the canary creation or update failed, this field provides details on the failure.
" } }, "StateReasonCode": { "target": "com.amazonaws.synthetics#CanaryStateReasonCode", "traits": { - "smithy.api#documentation": "If the canary cannot run or has failed, this field displays the reason.
" + "smithy.api#documentation": "If the canary creation or update failed, this field displays the reason code.
" } } }, @@ -921,19 +990,19 @@ "RunConfig": { "target": "com.amazonaws.synthetics#CanaryRunConfigInput", "traits": { - "smithy.api#documentation": "A structure that contains the configuration for individual canary runs, \n such as timeout value and environment variables.
\nThe environment variables keys and values are not encrypted. Do not store sensitive information\n in this field.
\nA structure that contains the configuration for individual canary runs, \n such as timeout value and environment variables.
\nEnvironment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables \n are not encrypted on the client side. Do not store sensitive information\n in them.
\nThe number of days to retain data about successful runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + "smithy.api#documentation": "The number of days to retain data about successful runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "The number of days to retain data about failed runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + "smithy.api#documentation": "The number of days to retain data about failed runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "RuntimeVersion": { @@ -1481,6 +1550,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.synthetics#DryRunConfigOutput": { + "type": "structure", + "members": { + "DryRunId": { + "target": "com.amazonaws.synthetics#UUID", + "traits": { + "smithy.api#documentation": "The DryRunId associated with an existing canary\u2019s dry run. You can use this DryRunId to retrieve information about the dry run.
" + } + }, + "LastDryRunExecutionStatus": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "Returns the last execution status for a canary's dry run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the dry run configurations set for a canary.
" + } + }, "com.amazonaws.synthetics#EncryptionMode": { "type": "enum", "members": { @@ -1564,6 +1653,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "DryRunId": { + "target": "com.amazonaws.synthetics#UUID", + "traits": { + "smithy.api#documentation": "The DryRunId associated with an existing canary\u2019s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "smithy.api#httpQuery": "dryRunId" + } } }, "traits": { @@ -1631,7 +1727,7 @@ "NextToken": { "target": "com.amazonaws.synthetics#Token", "traits": { - "smithy.api#documentation": "A token that indicates that there is more data\n available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next \n set of results.
A token that indicates that there is more data\n available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next \n set of results.
When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.
\nSpecify this parameter to limit how many runs are returned each time you use\n the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
The DryRunId associated with an existing canary\u2019s dry run. You can use this DryRunId to retrieve information about the dry run.
" + } + }, + "RunType": { + "target": "com.amazonaws.synthetics#RunType", + "traits": { + "smithy.api#documentation": "When you provide RunType=CANARY_RUN and dryRunId, you will get an exception\n \n \n
When a value is not provided for RunType, the default value is CANARY_RUN\n
When CANARY_RUN is provided, all canary runs excluding dry runs are returned
When DRY_RUN is provided, all dry runs excluding canary runs are returned
The maximum number of retries. The value must be less than or equal to 2.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the canary's retry configuration.
\nThe default account level concurrent execution limit from Lambda is 1000. When you have more than 1000 canaries, it's possible there are more than 1000 Lambda invocations due to retries and the console might hang. For more information on the Lambda execution limit, \n see Understanding Lambda function scaling.
\nFor canary with MaxRetries = 2, you need to set the CanaryRunConfigInput.TimeoutInSeconds to less than 600 seconds to avoid validation errors.
The maximum number of retries. The value must be less than or equal to 2.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the canary's retry configuration.
" + } + }, "com.amazonaws.synthetics#RoleArn": { "type": "string", "traits": { @@ -2340,6 +2495,23 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.synthetics#RunType": { + "type": "enum", + "members": { + "CANARY_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANARY_RUN" + } + }, + "DRY_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRY_RUN" + } + } + } + }, "com.amazonaws.synthetics#RuntimeVersion": { "type": "structure", "members": { @@ -2457,6 +2629,121 @@ } } }, + "com.amazonaws.synthetics#StartCanaryDryRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.synthetics#StartCanaryDryRunRequest" + }, + "output": { + "target": "com.amazonaws.synthetics#StartCanaryDryRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.synthetics#AccessDeniedException" + }, + { + "target": "com.amazonaws.synthetics#ConflictException" + }, + { + "target": "com.amazonaws.synthetics#InternalServerException" + }, + { + "target": "com.amazonaws.synthetics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.synthetics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to start a dry run for a canary that has already been created
", + "smithy.api#http": { + "method": "POST", + "uri": "/canary/{Name}/dry-run/start", + "code": 200 + } + } + }, + "com.amazonaws.synthetics#StartCanaryDryRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.synthetics#CanaryName", + "traits": { + "smithy.api#documentation": "The name of the canary that you want to dry run. To find\n canary names, use DescribeCanaries.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.synthetics#CanaryCodeInput" + }, + "RuntimeVersion": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "Specifies the runtime version to use for the canary. \n For a list of valid runtime versions and for more information about\n runtime versions, see \n Canary Runtime Versions.
" + } + }, + "RunConfig": { + "target": "com.amazonaws.synthetics#CanaryRunConfigInput" + }, + "VpcConfig": { + "target": "com.amazonaws.synthetics#VpcConfigInput" + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.synthetics#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role to be used to run the canary. This role must already exist, \n and must include lambda.amazonaws.com as a principal in the trust\n policy. The role must also have the following permissions:
The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" + } + }, + "FailureRetentionPeriodInDays": { + "target": "com.amazonaws.synthetics#MaxSize1024", + "traits": { + "smithy.api#documentation": "The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" + } + }, + "VisualReference": { + "target": "com.amazonaws.synthetics#VisualReferenceInput" + }, + "ArtifactS3Location": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "The location in Amazon S3 where Synthetics stores artifacts from the test runs of this\n canary. Artifacts include the log file, screenshots, and HAR files. The name of the \n Amazon S3 bucket can't include a period (.).
" + } + }, + "ArtifactConfig": { + "target": "com.amazonaws.synthetics#ArtifactConfigInput" + }, + "ProvisionedResourceCleanup": { + "target": "com.amazonaws.synthetics#ProvisionedResourceCleanupSetting", + "traits": { + "smithy.api#documentation": "Specifies whether to also delete the Lambda functions and layers used by this canary\n when the canary is deleted. If the value of this parameter is AUTOMATIC, it means\n that the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter\n of the DeleteCanary operation\n determines whether the Lambda functions and layers will be deleted.
Returns the dry run configurations for a canary.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.synthetics#StartCanaryRequest": { "type": "structure", "members": { @@ -2619,6 +2906,9 @@ { "target": "com.amazonaws.synthetics#StartCanary" }, + { + "target": "com.amazonaws.synthetics#StartCanaryDryRun" + }, { "target": "com.amazonaws.synthetics#StopCanary" }, @@ -3842,6 +4132,9 @@ "target": "com.amazonaws.synthetics#UpdateCanaryResponse" }, "errors": [ + { + "target": "com.amazonaws.synthetics#AccessDeniedException" + }, { "target": "com.amazonaws.synthetics#ConflictException" }, @@ -3859,7 +4152,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of a canary that has \n already been created.
\nYou can't use this operation to update the tags of an existing canary. To \n change the tags of an existing canary, use\n TagResource.
", + "smithy.api#documentation": "Updates the configuration of a canary that has \n already been created.
\nYou can't use this operation to update the tags of an existing canary. To \n change the tags of an existing canary, use\n TagResource.
\nWhen you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
A structure that contains the timeout value that is used for each individual run of the \n canary.
\nThe environment variables keys and values are not encrypted. Do not store sensitive information\n in this field.
\nA structure that contains the timeout value that is used for each individual run of the \n canary.
\nEnvironment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables \n are not encrypted on the client side. Do not store sensitive information\n in them.
\nThe number of days to retain data about successful runs of this canary.
" + "smithy.api#documentation": "The number of days to retain data about successful runs of this canary.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "The number of days to retain data about failed runs of this canary.
" + "smithy.api#documentation": "The number of days to retain data about failed runs of this canary.
\nThis setting affects the range of information returned by GetCanaryRuns, as well as \n the range of information displayed in the Synthetics console.\n
" } }, "VpcConfig": { @@ -3949,6 +4242,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to also delete the Lambda functions and layers used by this canary\n when the canary is deleted.
\nIf the value of this parameter is OFF, then the value of the DeleteLambda parameter\n of the DeleteCanary operation\n determines whether the Lambda functions and layers will be deleted.
Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.
\nWhen you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
Indicates the timeout settings of the pool.
" } + }, + "RunningMode": { + "target": "com.amazonaws.workspaces#PoolsRunningMode", + "traits": { + "smithy.api#documentation": "The running mode for the pool.
" + } } }, "traits": { @@ -2923,12 +2929,6 @@ "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties": { "type": "structure", "members": { - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "Specifies whether the directory is enabled for Amazon WorkDocs.
" - } - }, "EnableInternetAccess": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { @@ -7681,6 +7681,23 @@ "target": "com.amazonaws.workspaces#PendingCreateStandbyWorkspacesRequest" } }, + "com.amazonaws.workspaces#PoolsRunningMode": { + "type": "enum", + "members": { + "AUTO_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_STOP" + } + }, + "ALWAYS_ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_ON" + } + } + } + }, "com.amazonaws.workspaces#Protocol": { "type": "enum", "members": { @@ -7933,12 +7950,6 @@ "smithy.api#documentation": "The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the\n subnets are in supported Availability Zones. The subnets must also be in separate\n Availability Zones. If these conditions are not met, you will receive an\n OperationNotSupportedException error.
" } }, - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this\n parameter and WorkDocs is not available in the Region, you will receive an\n OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try\n again.
Indicates the timeout settings of the specified pool.
" } + }, + "RunningMode": { + "target": "com.amazonaws.workspaces#PoolsRunningMode", + "traits": { + "smithy.api#documentation": "The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.
" + } } }, "traits": { @@ -10471,12 +10488,6 @@ "com.amazonaws.workspaces#WorkspaceCreationProperties": { "type": "structure", "members": { - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
\nIf WorkDocs is already enabled for a WorkSpaces directory and you disable it, new\n WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs\n remains enabled for any existing WorkSpaces, unless you either disable users' access to\n WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see\n Disabling Users in the Amazon WorkDocs Administration\n Guide. To delete a WorkDocs site, see Deleting a Site in the\n Amazon WorkDocs Administration Guide.
\nIf you enable WorkDocs on a directory that already has existing WorkSpaces, the\n existing WorkSpaces and any new WorkSpaces that are launched in the directory will have\n WorkDocs enabled.
\nThe name of the pool,
", + "smithy.api#documentation": "The name of the pool.
", "smithy.api#required": {} } }, @@ -11755,6 +11784,14 @@ "traits": { "smithy.api#documentation": "The amount of time that a pool session remains active after users disconnect. \n If they try to reconnect to the pool session after a disconnection or network interruption \n within this time interval, they are connected to their previous session. \n Otherwise, they are connected to a new session with a new pool instance.
" } + }, + "RunningMode": { + "target": "com.amazonaws.workspaces#PoolsRunningMode", + "traits": { + "smithy.api#default": "AUTO_STOP", + "smithy.api#documentation": "The running mode of the pool.
", + "smithy.api#required": {} + } } }, "traits": { diff --git a/settings.gradle.kts b/settings.gradle.kts index 0a6d13e6..8d988818 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -6,14 +6,10 @@ pluginManagement { } } -// Dynamically create subprojects for each model defined in the properties file -settings.extra.properties.forEach { - if (it.key.startsWith("model.") && it.key.endsWith(".version")) { - val project = it.key.substring(6, it.key.length - 8) - // Skip the "all" project, it is set up in the root gradle file - if (project != "all") { - include(project) - project(":${project}").projectDir = file("models/${project}") - } +// Dynamically create subprojects for each directory in models/ +fileTree("models/").files.forEach { + if (it.isDirectory && !it.isHidden) { + include(it.name) + project(":${it.name}").projectDir = it } }