Cancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.
Creates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCreates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.
" } }, "com.amazonaws.cloudtrail#CreateChannelRequest": { @@ -2368,7 +2368,7 @@ } ], "traits": { - "smithy.api#documentation": "\nCreates a custom dashboard or the Highlights dashboard.\n
\n\n Custom dashboards - Custom dashboards allow you to query \n events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
\n\n Highlights dashboard - You can create\n the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. \n CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
\n\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nCreates a custom dashboard or the Highlights dashboard.\n
\n\n Custom dashboards - Custom dashboards allow you to query \n events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
\n\n Highlights dashboard - You can create\n the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. \n CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.
\n\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.
", "smithy.api#idempotent": {} } }, @@ -2523,7 +2523,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new event data store.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nCreates a new event data store.
" } }, "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { @@ -2821,7 +2821,7 @@ "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the\n log files.
" + "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the\n log files. Setting this value to true only delivers global service events to\n the trail if the trail is multi-Region or if the trail's home Region is the partition leader\n Region (for example, us-east-1).
Specifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
Specifies whether the trail is publishing events from global services such as IAM to the\n log files.
" + "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the\n log files. Setting this value to true only delivers global service events to\n the trail if the trail is multi-Region or if the trail's home Region is the partition leader\n Region (for example, us-east-1).
Specifies whether the trail is an organization trail.
" } + }, + "RecursiveLogging": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail.
" + } } }, "traits": { @@ -3129,7 +3141,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a channel.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nDeletes a channel.
" } }, "com.amazonaws.cloudtrail#DeleteChannelRequest": { @@ -3174,7 +3186,7 @@ } ], "traits": { - "smithy.api#documentation": "\nDeletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.\n
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nDeletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.\n
", "smithy.api#idempotent": {} } }, @@ -3253,7 +3265,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store and the FederationStatus must be DISABLED. \n You cannot delete an event data store if TerminationProtectionEnabled \n is True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nDisables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store and the FederationStatus must be DISABLED. \n You cannot delete an event data store if TerminationProtectionEnabled \n is True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.
Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.
\nYou must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter \n returns information about the last query run for the alias. You can provide \n RefreshId along with QueryAlias to view the query results \n of a dashboard query for the specified RefreshId.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.
\nYou must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter \n returns information about the last query run for the alias. You can provide \n RefreshId along with QueryAlias to view the query results \n of a dashboard query for the specified RefreshId.
\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables \n the integration with Glue, Lake Formation, and Amazon Athena. \n After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
\nNo CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables \n the integration with Glue, Lake Formation, and Amazon Athena. \n After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
\nNo CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
" } }, "com.amazonaws.cloudtrail#DisableFederationRequest": { @@ -3971,7 +3983,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.
\nWhen you enable Lake query federation, CloudTrail\n creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for allowing fine-grained access control \n of the federated resources in the Glue Data Catalog.
For more information about Lake query federation, see Federate an event data store.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.
\nWhen you enable Lake query federation, CloudTrail\n creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for allowing fine-grained access control \n of the federated resources in the Glue Data Catalog.
For more information about Lake query federation, see Federate an event data store.
" } }, "com.amazonaws.cloudtrail#EnableFederationRequest": { @@ -4594,7 +4606,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Generates a query from a natural language prompt. This operation uses generative artificial intelligence\n (generative AI) to produce a ready-to-use SQL query from the prompt.\n
\nThe prompt can be a question or a statement about the event data\n in your event data store. For example, you can enter prompts like \"What are my\n top errors in the past month?\" and \u201cGive me a list of users that used SNS.\u201d
\nThe prompt must be in English. For information about limitations, permissions, and supported Regions, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.
\nDo not include any personally identifying, confidential, or sensitive information\n in your prompts.
\nThis feature uses generative AI large language models (LLMs); we recommend double-checking the\n LLM response.
\nCloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Generates a query from a natural language prompt. This operation uses generative artificial intelligence\n (generative AI) to produce a ready-to-use SQL query from the prompt.\n
\nThe prompt can be a question or a statement about the event data\n in your event data store. For example, you can enter prompts like \"What are my\n top errors in the past month?\" and \u201cGive me a list of users that used SNS.\u201d
\nThe prompt must be in English. For information about limitations, permissions, and supported Regions, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.
\nDo not include any personally identifying, confidential, or sensitive information\n in your prompts.
\nThis feature uses generative AI large language models (LLMs); we recommend double-checking the\n LLM response.
\nReturns information about a specific channel.\n
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about a specific channel.\n
", "smithy.api#idempotent": {} } }, @@ -4769,7 +4781,7 @@ } ], "traits": { - "smithy.api#documentation": "\nReturns the specified dashboard.\n
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nReturns the specified dashboard.\n
", "smithy.api#idempotent": {} } }, @@ -4994,7 +5006,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an event data store specified as either an ARN or the ID\n portion of the ARN.
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about an event data store specified as either an ARN or the ID\n portion of the ARN.
", "smithy.api#idempotent": {} } }, @@ -5208,7 +5220,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a specific import.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about a specific import.
" } }, "com.amazonaws.cloudtrail#GetImportRequest": { @@ -5429,7 +5441,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nGets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.
Lists the channels in the current account, and their source names. \n
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nLists the channels in the current account, and their source names. \n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -7001,7 +7013,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns information about all dashboards in the account, in the current Region.\n
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Returns information about all dashboards in the account, in the current Region.\n
", "smithy.api#idempotent": {} } }, @@ -7092,7 +7104,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about all event data stores in the account, in the current\n Region.
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns information about all event data stores in the account, in the current\n Region.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -7173,7 +7185,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of failures for the specified import.
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns a list of failures for the specified import.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -7265,7 +7277,7 @@ } ], "traits": { - "smithy.api#documentation": " Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.
Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.
\nListInsightsData supports the following Dimensions for Insights events:
\nEvent ID
\nEvent name
\nEvent source
\nAll dimensions are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.
\nThe rate of ListInsightsData requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.
", + "smithy.api#documentation": "Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.
\nListInsightsData supports the following Dimensions for Insights events:
\nEvent ID
\nEvent name
\nEvent source
\nAll dimensions are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.
\nThe rate of ListInsightsData requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.
\nFor data event Insights on organization trails, only the management account and delegated\n administrator accounts can call ListInsightsData. For these callers, the API returns\n Insights events only for the caller's own account. Member accounts cannot call this API on\n organization trails.
Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, \n EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 90 days.
\nTo use ListInsightsMetricData operation, you must have the following permissions:
If ListInsightsMetricData is invoked with TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action and cloudtrail:ListInsightsData. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents and cloudtrail:ListInsightsData action on the specific trail.
If ListInsightsMetricData is invoked without TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action only. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents action.
Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, \n EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 90 days.
\nTo use ListInsightsMetricData operation, you must have the following permissions:
If ListInsightsMetricData is invoked with TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action and cloudtrail:ListInsightsData. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents and cloudtrail:ListInsightsData action on the specific trail.
If ListInsightsMetricData is invoked without TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action only. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents action.
For data event Insights on organization trails, only the management account and delegated\n administrator accounts can call ListInsightsMetricData. For these callers, the API returns\n Insights metrics only for the caller's own account. Member accounts cannot call this API on\n organization trails.
Returns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nReturns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.
Restores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nRestores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.
\n Searches sample queries and returns a list of sample queries that are sorted by relevance. \n To search for sample queries, provide a natural language SearchPhrase in English.\n
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\n Searches sample queries and returns a list of sample queries that are sorted by relevance. \n To search for sample queries, provide a natural language SearchPhrase in English.\n
\nStarts a refresh of the specified dashboard.\n
\n\n Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nStarts a refresh of the specified dashboard.\n
\n\n Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStarts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.
\nCloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.
\nStarts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.
\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStarts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.
\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
Stops a specified import.
" + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nStops a specified import.
" } }, "com.amazonaws.cloudtrail#StopImportRequest": { @@ -11157,7 +11172,7 @@ "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False.
" + "smithy.api#documentation": "Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail is an organization trail.
" } + }, + "RecursiveLogging": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
Updates a channel specified by a required channel ARN or UUID.
", + "smithy.api#documentation": "CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nUpdates a channel specified by a required channel ARN or UUID.
", "smithy.api#idempotent": {} } }, @@ -11515,7 +11536,7 @@ } ], "traits": { - "smithy.api#documentation": "\nUpdates the specified dashboard.\n
\n\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\n\nUpdates the specified dashboard.\n
\n\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n
\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n
Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or network activity events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
\nUpdates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or network activity events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
Specifies whether the trail is publishing events from global services such as IAM to the log files.
" + "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the log files. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to\n true, the trail will be created in all Amazon Web Services accounts that\n belong to the organization. If the trail is an organization trail and this is set to\n false, the trail will remain in the current Amazon Web Services account but\n be deleted from all member accounts in the organization.
Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to \n an organization trail.
\nSpecifies whether recursive logging is enabled for the trail. If you set\n RecursiveLogging to false, CloudTrail suppresses\n events generated by CloudTrail when it delivers log files to your trail's\n destinations, including Amazon S3 and CloudWatch Logs. The default value is\n true.
Specifies whether the trail is publishing events from global services such as IAM to the log files.
" + "smithy.api#documentation": "Specifies whether the trail is publishing events from global services such as IAM to the log files. Setting this value to true only delivers\n global service events to the trail if the trail is multi-Region or if the trail's home\n Region is the partition leader Region (for example, us-east-1).
Specifies whether the trail is an organization trail.
" } + }, + "RecursiveLogging": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether recursive logging is enabled for the trail.
" + } } }, "traits": { diff --git a/aws-models/ec2.json b/aws-models/ec2.json index d03d4cf5e..5a9e04738 100644 --- a/aws-models/ec2.json +++ b/aws-models/ec2.json @@ -11842,6 +11842,17 @@ "com.amazonaws.ec2#Boolean": { "type": "boolean" }, + "com.amazonaws.ec2#BootModeOverrideValues": { + "type": "enum", + "members": { + "uefi": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uefi" + } + } + } + }, "com.amazonaws.ec2#BootModeType": { "type": "enum", "members": { @@ -18636,6 +18647,18 @@ "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the \n request. For more information, see \n Ensure Idempotency.
", "smithy.api#idempotencyToken": {} } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to encrypt the volume copy. If the source volume is encrypted, the \n service always encrypts the copy regardless of this value. Set to true to \n encrypt a copy of an unencrypted source volume during the copy operation. If you set \n Encrypted to true but do not specify KmsKeyId, the \n service uses the default KMS key for EBS encryption in your account.
The identifier of the KMS key to use for encryption of the volume copy. Specify a \n symmetric encryption KMS key. You can specify a KMS key using the key ID, key ARN, alias \n name, or alias ARN. If you set Encrypted to true but do not \n specify this parameter, the service uses the default KMS key for EBS encryption in your \n account. For cross-account volume copies, this must be a KMS key in the calling \n account.
Only supported for instances in Local Zones and for instances on Outposts that support\n local snapshots. If the source instance is not in one of these locations, omit this\n parameter.
\nThe Amazon S3 location where the snapshots will be stored.
\nTo create local snapshots in the same Local Zone or on the same Outpost as the source\n instance, specify local.
To create regional snapshots in the parent Region of the Local Zone or Outpost, specify\n regional.
If the source instance is in a Local Zone and you omit this parameter, regional snapshots\n are created in the parent Region of the Local Zone.
\nIf the source instance is on an Outpost that supports local snapshots, this parameter is\n required. If you omit it, the request fails with an\n InvalidParameterValue error.
Default: regional (for instances in Local Zones only)
The boot mode of the new image, which overrides the default boot mode. By default, \n if you do not specify this parameter, the new image inherits \n the boot-mode from the source instance.
A value of uefi indicates that the image only supports UEFI boot mode. You can\n specify this parameter only if the current-instance-boot-mode of the source instance is\n uefi. To find the boot-mode or current-instance-boot-mode of \n an instance, see DescribeInstances.
The operating system contained in the AMI must be configured to support the specified\n boot mode.
\nFor more information, see Instance launch behavior with Amazon EC2 boot modes in\n the Amazon EC2 User Guide.
" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -42548,7 +42577,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" }, "traits": { - "smithy.api#documentation": "Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not a burstable performance instance, Amazon EC2 returns the\n standard credit option.
Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.
\nFor more information, see Burstable\n performance instances in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -110794,6 +110823,14 @@ "smithy.api#documentation": "The maximum number of the ENA queues for each interface.
", "smithy.api#xmlName": "maximumEnaQueueCountPerInterface" } + }, + "InterfaceTypes": { + "target": "com.amazonaws.ec2#NetworkCardInterfaceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceTypeSet", + "smithy.api#documentation": "The supported interface types for the network card.
", + "smithy.api#xmlName": "interfaceTypeSet" + } } }, "traits": { @@ -110809,6 +110846,44 @@ } } }, + "com.amazonaws.ec2#NetworkCardInterfaceType": { + "type": "enum", + "members": { + "interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "interface" + } + }, + "efa": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa" + } + }, + "efa_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa-only" + } + }, + "secondary": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "secondary" + } + } + } + }, + "com.amazonaws.ec2#NetworkCardInterfaceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#NetworkCardInterfaceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#NetworkInfo": { "type": "structure", "members": { @@ -141735,6 +141810,22 @@ "smithy.api#xmlName": "volumeInitializationRate" } }, + "VolumeArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume.
", + "smithy.api#xmlName": "volumeArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the volume.
", + "smithy.api#xmlName": "ownerId" + } + }, "VolumeId": { "target": "com.amazonaws.ec2#String", "traits": { diff --git a/aws-models/ecs.json b/aws-models/ecs.json index 40f612c8a..24f6ff836 100644 --- a/aws-models/ecs.json +++ b/aws-models/ecs.json @@ -4665,6 +4665,12 @@ "smithy.api#documentation": "The amount of memory (in MiB) used by the task. This parameter determines the memory allocation for each task in the Express service. The default value for an express service is 512 MiB.
" } }, + "cpuArchitecture": { + "target": "com.amazonaws.ecs#ExpressCpuArchitecture", + "traits": { + "smithy.api#documentation": "The CPU architecture that the tasks in the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the default is X86_64.
Valid values:
X86_64 - The x86 64-bit architecture.
ARM64 - The 64-bit ARM architecture.
Make sure that the container image that you specify supports the architecture that you choose. The operating system family for an Express service is always LINUX.
You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.
The Amazon Resource Name (ARN) of a task definition to use to create the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.
The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.
If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, or memory.
The Amazon Resource Name (ARN) of a task definition to use to create the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.
The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.
If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, memory, or cpuArchitecture.
The memory allocation for tasks in this service revision.
" } }, + "cpuArchitecture": { + "target": "com.amazonaws.ecs#ExpressCpuArchitecture", + "traits": { + "smithy.api#documentation": "The CPU architecture that the tasks in this service revision run on. This is the architecture from the task definition that the service revision uses, so it reflects the default or the previously configured architecture when the request that created the revision didn't specify one.
Valid values:
X86_64 - The x86 64-bit architecture.
ARM64 - The 64-bit ARM architecture.
This value isn't returned when the task definition for the service revision doesn't specify a runtime platform. Because the architecture comes from each service revision's own task definition, revisions of the same service can report different architectures.
" + } + }, "networkConfiguration": { "target": "com.amazonaws.ecs#ExpressGatewayServiceNetworkConfiguration", "traits": { @@ -24528,6 +24557,12 @@ "smithy.api#documentation": "The amount of memory (in MiB) used by the task.
" } }, + "cpuArchitecture": { + "target": "com.amazonaws.ecs#ExpressCpuArchitecture", + "traits": { + "smithy.api#documentation": "The CPU architecture that the tasks in the Express service run on. Amazon ECS applies this value to the task definition revision that it registers for the service. If you don't specify a value, the service keeps the architecture that it currently runs on.
Valid values:
X86_64 - The x86 64-bit architecture.
ARM64 - The 64-bit ARM architecture.
Changing the architecture starts a new deployment that replaces the running tasks. Make sure that the container image that the service uses supports the architecture that you choose. The operating system family for an Express service is always LINUX.
You can't specify cpuArchitecture when you also specify taskDefinitionArn, because this value applies only to a task definition that Amazon ECS registers on your behalf.
The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.
The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.
If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, or memory.
The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.
The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.
If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, memory, or cpuArchitecture.
The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
", + "smithy.api#documentation": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see Lambda execution environment.
", "smithy.api#tags": [ "feature:public" ] @@ -13396,7 +13396,7 @@ "smithy.api#documentation": "Retrieves the provisioned concurrency configuration for a function's alias or version.
", "smithy.api#examples": [ { - "documentation": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "documentation": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", "input": { "FunctionName": "my-function", "Qualifier": "BLUE" @@ -13408,10 +13408,10 @@ "RequestedProvisionedConcurrentExecutions": 100, "Status": "READY" }, - "title": "To view a provisioned concurrency configuration" + "title": "To get a provisioned concurrency configuration" }, { - "documentation": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", + "documentation": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", "input": { "FunctionName": "my-function", "Qualifier": "BLUE" @@ -13423,7 +13423,7 @@ "RequestedProvisionedConcurrentExecutions": 100, "Status": "READY" }, - "title": "To get a provisioned concurrency configuration" + "title": "To view a provisioned concurrency configuration" } ], "smithy.api#http": { @@ -26732,7 +26732,7 @@ "Timeout": { "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
", + "smithy.api#documentation": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see Lambda execution environment.
", "smithy.api#tags": [ "feature:public" ] diff --git a/aws-models/mediaconvert.json b/aws-models/mediaconvert.json index a01d8ce33..e755597f6 100644 --- a/aws-models/mediaconvert.json +++ b/aws-models/mediaconvert.json @@ -1272,7 +1272,7 @@ } }, "traits": { - "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9." + "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use." } }, "com.amazonaws.mediaconvert#AssociateCertificate": { @@ -5745,6 +5745,20 @@ "smithy.api#jsonName": "contentLightLevel" } }, + "DisplayAspectRatio": { + "target": "com.amazonaws.mediaconvert#AspectRatio", + "traits": { + "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.", + "smithy.api#jsonName": "displayAspectRatio" + } + }, + "DolbyVision": { + "target": "com.amazonaws.mediaconvert#DolbyVisionMetadata", + "traits": { + "smithy.api#documentation": "Dolby Vision characteristics of the video track: the profile and level, and whether the RPU (dynamic metadata), base layer, and enhancement layer are present. Use this to distinguish Dolby Vision content from standard HEVC and to choose your encoding or passthrough settings. Omitted when the content is not Dolby Vision.", + "smithy.api#jsonName": "dolbyVision" + } + }, "FieldOrder": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -5794,6 +5808,13 @@ "smithy.api#jsonName": "rotation" } }, + "SampleAspectRatio": { + "target": "com.amazonaws.mediaconvert#AspectRatio", + "traits": { + "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.", + "smithy.api#jsonName": "sampleAspectRatio" + } + }, "ScanType": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -6254,7 +6275,7 @@ "Format": { "target": "com.amazonaws.mediaconvert#Format", "traits": { - "smithy.api#documentation": "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), WebM, MXF, Wave, AVI, MPEG-TS, MPEG-PS, MP3, FLAC, ASF (Windows Media / WMA), OGG. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.", + "smithy.api#documentation": "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), WebM, MXF, Wave, AVI, MPEG-TS, MPEG-PS, MP3, FLAC, ASF (Windows Media / WMA), or OGG. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.", "smithy.api#jsonName": "format" } }, @@ -8437,6 +8458,69 @@ "smithy.api#documentation": "Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to HDR10 1000, the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims." } }, + "com.amazonaws.mediaconvert#DolbyVisionMetadata": { + "type": "structure", + "members": { + "BaseLayer": { + "target": "com.amazonaws.mediaconvert#DolbyVisionPresence", + "traits": { + "smithy.api#documentation": "Whether a Dolby Vision component is present in the track.", + "smithy.api#jsonName": "baseLayer" + } + }, + "EnhancementLayer": { + "target": "com.amazonaws.mediaconvert#DolbyVisionPresence", + "traits": { + "smithy.api#documentation": "Whether a Dolby Vision component is present in the track.", + "smithy.api#jsonName": "enhancementLayer" + } + }, + "Level": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#documentation": "The Dolby Vision level, which indicates the maximum resolution and frame rate.", + "smithy.api#jsonName": "level" + } + }, + "Profile": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#documentation": "The Dolby Vision profile, for example 5, 7, or 8. The profile determines the layer structure and playback compatibility of the content.", + "smithy.api#jsonName": "profile" + } + }, + "Rpu": { + "target": "com.amazonaws.mediaconvert#DolbyVisionPresence", + "traits": { + "smithy.api#documentation": "Whether a Dolby Vision component is present in the track.", + "smithy.api#jsonName": "rpu" + } + } + }, + "traits": { + "smithy.api#documentation": "Dolby Vision characteristics of the video track: the profile and level, and whether the RPU (dynamic metadata), base layer, and enhancement layer are present. Use this to distinguish Dolby Vision content from standard HEVC and to choose your encoding or passthrough settings. Omitted when the content is not Dolby Vision." + } + }, + "com.amazonaws.mediaconvert#DolbyVisionPresence": { + "type": "enum", + "members": { + "PRESENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESENT" + } + }, + "ABSENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSENT" + } + } + }, + "traits": { + "smithy.api#documentation": "Whether a Dolby Vision component is present in the track." + } + }, "com.amazonaws.mediaconvert#DolbyVisionProfile": { "type": "enum", "members": { @@ -24399,6 +24483,9 @@ }, { "target": "com.amazonaws.mediaconvert#TooManyRequestsException" + }, + { + "target": "com.amazonaws.mediaconvert#UnprocessableEntityException" } ], "traits": { @@ -27472,6 +27559,22 @@ "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine to create a smoother picture. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture." } }, + "com.amazonaws.mediaconvert#UnprocessableEntityException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "The input file was recognized but appears to be malformed or corrupt.", + "smithy.api#error": "client", + "smithy.api#httpError": 422 + } + }, "com.amazonaws.mediaconvert#UntagResource": { "type": "operation", "input": { @@ -28859,7 +28962,7 @@ "DisplayAspectRatio": { "target": "com.amazonaws.mediaconvert#AspectRatio", "traits": { - "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9.", + "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.", "smithy.api#jsonName": "displayAspectRatio" } }, @@ -28901,7 +29004,7 @@ "SampleAspectRatio": { "target": "com.amazonaws.mediaconvert#AspectRatio", "traits": { - "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9.", + "smithy.api#documentation": "An aspect ratio expressed as a fraction with numerator and denominator values, reduced to lowest terms. Used for the sample (pixel) aspect ratio and the display aspect ratio of a video track. For example, a 720x576 anamorphic track has a sample aspect ratio of 64 / 45 and a display aspect ratio of 16 / 9. A video track can declare an aspect ratio in two independent places, and MediaConvert reports each one where it was found rather than choosing between them. The ratio declared by the container appears on the video track itself, and the ratio declared by the video essence appears under codecMetadata. When a file declares an aspect ratio in only one of the two places, the other is null; when it declares both and they disagree, you can compare them and decide which to use.", "smithy.api#jsonName": "sampleAspectRatio" } }, diff --git a/aws-models/s3.json b/aws-models/s3.json index 3e948c9d5..0cd5a6853 100644 --- a/aws-models/s3.json +++ b/aws-models/s3.json @@ -29392,6 +29392,27 @@ "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, + "ObjectLockEventHold": { + "target": "com.amazonaws.s3#ObjectLockEventHold", + "traits": { + "smithy.api#documentation": "The event hold status to apply to the object copy. Set to ON to enable or\n OFF to disable.
This functionality is not supported for directory buckets.
\nThe event hold duration in days to apply to the object copy. You cannot specify a duration\n in both days and years.
\nThis functionality is not supported for directory buckets.
\nThe event hold duration in years to apply to the object copy. You cannot specify a\n duration in both days and years.
\nThis functionality is not supported for directory buckets.
\nThe Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the checksum was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.
Specifies the event hold status to apply to the uploaded object. Set to ON to enable\n or OFF to disable.
This functionality is not supported for directory buckets.
\nSpecifies the event hold duration in days to apply to the uploaded object. You cannot\n specify a duration in both days and years.
\nThis functionality is not supported for directory buckets.
\nSpecifies the event hold duration in years to apply to the uploaded object. You cannot\n specify a duration in both days and years.
\nThis functionality is not supported for directory buckets.
\nThe number of years that you want to specify for the default retention period. Must be used with\n Mode.
The default event hold duration to be applied to new objects placed in the specified bucket. When\n configured, new objects will automatically have an event hold enabled with this duration.
" + } } }, "traits": { @@ -32520,6 +32568,12 @@ "traits": { "smithy.api#enumValue": "s3:ObjectAnnotation:Delete" } + }, + "s3_ObjectRetention_Put": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3:ObjectRetention:Put" + } } }, "traits": { @@ -32533,6 +32587,26 @@ "smithy.api#documentation": "A container for specifying the configuration for Amazon EventBridge.
" } }, + "com.amazonaws.s3#EventHoldDuration": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "The number of days for the event hold duration. The minimum value is 1 and the maximum value is\n 36,500.
" + } + }, + "Years": { + "target": "com.amazonaws.s3#Years", + "traits": { + "smithy.api#documentation": "The number of years for the event hold duration. The minimum value is 1 and the maximum value is\n 100.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the event hold duration configuration, specified in either days or years.
" + } + }, "com.amazonaws.s3#EventList": { "type": "list", "member": { @@ -35335,7 +35409,7 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the checksum was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.
Indicates whether this object has an active legal hold. This field is only returned if you have\n permission to view an object's legal hold status.
\nThis functionality is not supported for directory buckets.
\nThe event hold status for this object. This header is only returned if the requester has the\n s3:GetObjectRetention permission.
This functionality is not supported for directory buckets.
\nThe event hold duration in days for this object. Only returned when the event hold is\n enabled.
\nThis functionality is not supported for directory buckets.
\nThe event hold duration in years for this object. Only returned when the event hold is\n enabled.
\nThis functionality is not supported for directory buckets.
\nSpecifies whether a legal hold is in effect for this object. This header is only returned if the\n requester has the s3:GetObjectLegalHold permission. This header is not returned if the\n specified version of this object has never had a legal hold applied. For more information about S3\n Object Lock, see Object\n Lock.
This functionality is not supported for directory buckets.
\nThe event hold status for this object. This header is only returned if the requester has the\n s3:GetObjectRetention permission.
This functionality is not supported for directory buckets.
\nThe event hold duration in days for this object. Only returned when the event hold is\n enabled.
\nThis functionality is not supported for directory buckets.
\nThe event hold duration in years for this object. Only returned when the event hold is\n enabled.
\nThis functionality is not supported for directory buckets.
\nThe date on which this Object Lock Retention will expire.
" } + }, + "EventHold": { + "target": "com.amazonaws.s3#ObjectLockEventHold", + "traits": { + "smithy.api#documentation": "The event hold status for the object. Set to ON to enable an event hold or\n OFF to disable it.
The event hold duration for the object. Specifies how long the object remains protected after the\n event hold is released.
" + } } }, "traits": { @@ -40994,7 +41157,7 @@ "DefaultRetention": { "target": "com.amazonaws.s3#DefaultRetention", "traits": { - "smithy.api#documentation": "The default Object Lock retention mode and period that you want to apply to new objects placed in\n the specified bucket. Bucket settings require both a mode and a period. The period can be either\n Days or Years but you must select one. You cannot specify Days\n and Years at the same time.
The default Object Lock retention settings for new objects in this bucket. You can\n specify:
\nA default retention period, by using Days or Years.
A default event hold duration, by using DefaultEventHold. This setting also\n uses days or years.
You can set one or both. You cannot use days and years in the same setting.
" } } }, @@ -44732,6 +44895,27 @@ "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, + "ObjectLockEventHold": { + "target": "com.amazonaws.s3#ObjectLockEventHold", + "traits": { + "smithy.api#documentation": "Specifies the event hold status to apply to this object. Set to ON to enable or\n OFF to disable.
This functionality is not supported for directory buckets.
\nSpecifies the event hold duration in days to apply to this object. You cannot specify a\n duration in both days and years.
\nThis functionality is not supported for directory buckets.
\nSpecifies the event hold duration in years to apply to this object. You cannot specify a\n duration in both days and years.
\nThis functionality is not supported for directory buckets.
\nAttaches an elastic network interface (ENI) to a node in a HyperPod cluster.
To use this operation, you must have the sagemaker:AttachClusterNodeNetworkInterface permission.
The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster that contains the target node.
", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the cluster node to which you want to attach the network interface. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).
", + "smithy.api#required": {} + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.sagemaker#ClusterNetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the elastic network interface (ENI) to attach.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AttachClusterNodeNetworkInterfaceResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the network interface attachment operation was performed.
", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the cluster node where your network interface was attached.
", + "smithy.api#required": {} + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.sagemaker#ClusterNetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the elastic network interface (ENI) that was attached.
", + "smithy.api#required": {} + } + }, + "AttachmentId": { + "target": "com.amazonaws.sagemaker#ClusterNetworkInterfaceAttachmentId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier of the network interface attachment. Use this value to reference or detach the network interface later.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#AttachClusterNodeVolume": { "type": "operation", "input": { @@ -12805,6 +12897,16 @@ "smithy.api#documentation": "The network interface configuration for a Amazon SageMaker HyperPod cluster instance group.
" } }, + "com.amazonaws.sagemaker#ClusterNetworkInterfaceAttachmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 28 + }, + "smithy.api#pattern": "^eni-attach-[0-9a-f]{8}(?:[0-9a-f]{9})?$" + } + }, "com.amazonaws.sagemaker#ClusterNetworkInterfaceDetails": { "type": "structure", "members": { @@ -12819,6 +12921,16 @@ "smithy.api#documentation": "The network interface configuration details for a Amazon SageMaker HyperPod cluster instance group.
" } }, + "com.amazonaws.sagemaker#ClusterNetworkInterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 21 + }, + "smithy.api#pattern": "^eni-[0-9a-f]{8}(?:[0-9a-f]{9})?$" + } + }, "com.amazonaws.sagemaker#ClusterNodeDetails": { "type": "structure", "members": { @@ -46004,6 +46116,47 @@ } } }, + "com.amazonaws.sagemaker#InstancePreference": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
The number of instances to launch if this instance type is selected. Specify the instance count for the training job in one of the following two ways:
Per preference \u2013 Set InstanceCount on every preference in the InstancePreferences list and don't set ResourceConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.
One count for the job \u2013 Set ResourceConfig$InstanceCount and omit it from every preference. SageMaker applies this to all instance types in the list.
For example, in a list of five preferences, either all five specify InstanceCount or none of them do. SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ResourceConfig, or that omit it in both places.
The Amazon Resource Name (ARN) of a training plan to use if this instance type is selected. The plan's instance type must match InstanceType. A preference with a training plan uses that plan's reserved capacity; a preference without one uses on-demand capacity. Per-preference TrainingPlanArns is mutually exclusive with the job-level TrainingPlanArn in ResourceConfig.
A candidate instance type preference in an InstancePreferences list.
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 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.
An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.
InstancePreferences is mutually exclusive with InstanceType.
The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
The number of instances of SelectedInstanceType that the job launched with. The job is billed for this instance type and count. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
The ML compute instance type. An instance type can appear only once in an InstancePreferences list.
The number of instances to launch if this instance type is selected. Specify the instance count for the processing job in one of the following two ways:
Per preference \u2013 Set InstanceCount on every preference in the InstancePreferences list and don't set ProcessingClusterConfig$InstanceCount. Use this when each instance type needs a different number of instances to deliver equivalent compute.
One count for the job \u2013 Set ProcessingClusterConfig$InstanceCount and omit it from every preference. Amazon SageMaker applies this to all instance types in the list.
For example, in a list of five preferences, either all five specify InstanceCount or none of them do. Amazon SageMaker rejects requests that set InstanceCount on only some preferences, that set it both per preference and in ProcessingClusterConfig, or that omit it in both places.
A candidate instance type preference in a processing InstancePreferences list.
Configuration for how training job instances are placed and allocated within UltraServers. Only applicable for UltraServer capacity.
" } + }, + "InstancePreferences": { + "target": "com.amazonaws.sagemaker#InstancePreferenceList", + "traits": { + "smithy.api#documentation": "An ordered list of ML compute instance types for the training job, in priority order. SageMaker launches the training job on the first instance type in the list that has available capacity. If capacity is insufficient, SageMaker evaluates the next instance type in the preferred list. Exactly one instance type is selected for the job.
InstancePreferences is mutually exclusive with InstanceType, InstanceGroups, InstancePlacementConfig, and EnableManagedSpotTraining, and supports only Flexible Training Plans (FTP) and On-Demand capacity.
The instance type that SageMaker selected for the job from the provided InstancePreferences. The job is billed for this instance type and count. Returned by DescribeTrainingJob after an instance type is selected. This field is read-only and isn't accepted in CreateTrainingJob requests.
The number of instances of SelectedInstanceType that the training job launched with. The job is billed for this instance type and count. Returned by DescribeTrainingJob after an instance type is selected. This field is read-only and isn't accepted in CreateTrainingJob requests.
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.
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.
MaxPendingTimeInSeconds takes effect only for jobs that request accelerated computing instance types, such as instances in the ml.p, ml.g, and ml.trn families. It has no effect on jobs that request CPU-only instance types.
If the job specifies InstancePreferences, MaxPendingTimeInSeconds bounds the total time SageMaker spends working through your list of instance types. It is not applied per instance type preference, and takes effect only when the list includes at least one accelerated computing instance type.
Local AWS cloud emulator for integration tests. Run your app with normal AWS clients, stay fully local, and use fakecloud SDKs when your tests need deeper visibility.
-105 services. 7,505 operations. 248,557/248,557 Smithy variants pass — true 100% conformance.
+105 services. 7,506 operations. 248,557/248,557 Smithy variants pass — true 100% conformance.